Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
C
cas741
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
W. Spencer Smith
cas741
Commits
a8d9229f
Commit
a8d9229f
authored
4 years ago
by
W. Spencer Smith
Browse files
Options
Downloads
Patches
Plain Diff
Initial checklist for code
parent
4362d578
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
BlankProjectTemplate/src/Code-Checklist.pdf
+0
-0
0 additions, 0 deletions
BlankProjectTemplate/src/Code-Checklist.pdf
BlankProjectTemplate/src/Code-Checklist.tex
+71
-0
71 additions, 0 deletions
BlankProjectTemplate/src/Code-Checklist.tex
with
71 additions
and
0 deletions
BlankProjectTemplate/src/Code-Checklist.pdf
0 → 100644
+
0
−
0
View file @
a8d9229f
File added
This diff is collapsed.
Click to expand it.
BlankProjectTemplate/src/Code-Checklist.tex
0 → 100644
+
71
−
0
View file @
a8d9229f
\documentclass
[12pt]
{
article
}
\usepackage
{
hyperref
}
\hypersetup
{
colorlinks=true,
linkcolor=blue,
citecolor=blue,
filecolor=blue,
urlcolor=blue,
unicode=false
}
\urlstyle
{
same
}
\usepackage
{
enumitem,amssymb
}
\newlist
{
todolist
}{
itemize
}{
2
}
\setlist
[todolist]
{
label=
$
\square
$}
\usepackage
{
pifont
}
\newcommand
{
\cmark
}{
\ding
{
51
}}
%
\newcommand
{
\xmark
}{
\ding
{
55
}}
%
\newcommand
{
\done
}{
\rlap
{$
\square
$}{
\raisebox
{
2pt
}{
\large\hspace
{
1pt
}
\cmark
}}
%
\hspace
{
-2.5pt
}}
\newcommand
{
\wontfix
}{
\rlap
{$
\square
$}{
\large\hspace
{
1pt
}
\xmark
}}
\begin{document}
\title
{
Source Code Checklist
}
\author
{
Spencer Smith
}
\date
{
\today
}
\maketitle
% Show an item is done by \item[\done] Frame the problem
% Show an item will not be fixed by \item[\wontfix] profit
\begin{itemize}
\item
Identifier naming
\begin{todolist}
\item
Identifier names are consistent
\item
Identifier names are meaningful
\end{todolist}
\item
Coding
\begin{todolist}
\item
Source code in the src folder
\item
Comments on ``what'' not ``how''
\item
Avoid hard-coded constants (other than maybe 0 or 1)
\item
Consistent indentation
\item
Explicit identification of coding standard being followed
\item
Code standard is followed
\item
Parameters in the same order for all functions
\end{todolist}
\item
Relation to other documents
\begin{todolist}
\item
Descriptive name for source code files
\item
Mapping to module guide is clear, may require a document explicitly
mapping between modules and code files
\item
Show mapping between MIS symbols and code symbols
\end{todolist}
\item
Readability
\begin{todolist}
\item
Code is reasonably understandable to someone that knows the
programming language, but is new to the project
\item
Esoteric language features avoided when a simpler language feature
could be used/
\item
Incomplete code is flagged with a suitable marker, such as ``TO DO''?
\end{todolist}
\end{itemize}
\end{document}
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment