Skip to content
Snippets Groups Projects
Commit a8d9229f authored by W. Spencer Smith's avatar W. Spencer Smith
Browse files

Initial checklist for code

parent 4362d578
No related branches found
No related tags found
No related merge requests found
File added
\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}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment