docs/codingstyle.tex

   1 \documentclass{article}
   2 \usepackage{palatino}
   3
   4 \newcommand{\bold}[1]{{\raggedleft\bfseries\upshape #1}}
   5
   6 \begin{document}
   7
   8 \section{Classes}
   9
  10 \subsection{Class names}
  11
  12 Class names should be UpperCase.
  13
  14 \bold{Reason:} Code uniformity.
  15
  16 \subsubsection{Examples}
  17
  18 \bold{Good:}
  19
  20 \begin{verbatim}
  21 class SocketIPC{
  22 \end{verbatim}
  23
  24 \bold{Bad:}
  25
  26 \begin{verbatim}
  27 class socketipc{
  28 \end{verbatim}
  29
  30 \subsection{Function Names}
  31
  32 Class function names should be UpperCase, except
  33 when using any of the following prefixes, in which
  34 case they whould be in cammelCase:
  35
  36 \begin{itemize}
  37 \item{is}  - isAlive
  38 \item{get} - getValue
  39 \item{set} - setValue
  40 \item{has} - hasKey
  41 \end{itemize}
  42
  43 \bold{Reason:} Code readability.
  44
  45 \subsubsection{Examples}
  46
  47 \bold{Good:}
  48
  49 \begin{verbatim}
  50 int getValue();
  51 int Height();
  52 \end{verbatim}
  53
  54 \bold{Bad:}
  55
  56 \begin{verbatim}
  57 int GetValue();
  58 int height();
  59 \end{verbatim}
  60
  61
  62 \section{Spaces}
  63
  64 \subsection{Identation}
  65
  66 Code should be idented with tabs.
  67
  68 \bold{Reason:} Code readability.
  69
  70 \subsubsection{Examples}
  71
  72 \bold{Good:}
  73
  74 \begin{verbatim}
  75 int func(){
  76     int i;
  77
  78     for (i = 0; i < 100; i++){
  79         /* Do something */
  80     }
  81 }
  82 \end{verbatim}
  83
  84 \bold{Bad:}
  85
  86 \begin{verbatim}
  87 int func(){
  88 int i;
  89 for (i = 0; i < 100; i++){
  90 /* Do something */
  91 }
  92 }
  93 \end{verbatim}
  94
  95 \subsection{For Loops}
  96
  97 For construct should have an space after "for", there should not
  98 be spaces between the parenthesis.
  99
 100 \bold{Reason:} Code readability and uniformity.
 101
 102 \subsubsection{Examples}
 103
 104 \bold{Good:}
 105
 106 \begin{verbatim}
 107 for (i = 0; i < 100; i++){
 108 }
 109 \end{verbatim}
 110
 111 \bold{Bad:}
 112
 113 \begin{verbatim}
 114 for( i = 0 ; i < 100 ; i++ ){
 115 }
 116 \end{verbatim}
 117
 118
 119 \section{Brackets}
 120
 121
 122 \subsection{Loop Brackets}
 123
 124 They should be on the same line of the loop construct.
 125
 126 \bold{Reason:} Wastes a line.
 127
 128 \subsubsection{Examples}
 129
 130 \bold{Good:}
 131
 132 \begin{verbatim}
 133 for (i = 0; i < 100; i++){
 134 \end{verbatim}
 135
 136 \bold{Bad:}
 137
 138 \begin{verbatim}
 139 for (i = 0; i < 100; i++)
 140 {
 141 \end{verbatim}
 142
 143
 144 \subsection{Function Brackets}
 145
 146 They should be in the same line of the function.
 147
 148 \bold{Reason:} Having the brancket in the next line wastes it,
 149 probably doesn't add much to readability.
 150
 151 \subsubsection{Examples}
 152
 153 \bold{Good:}
 154
 155 \begin{verbatim}
 156 int main(int argc, char **argv){
 157 \end{verbatim}
 158
 159 \bold{Bad:}
 160
 161 \begin{verbatim}
 162 int main(int argc, char **argv)
 163 {
 164 \end{verbatim}
 165
 166 \end{document}