docs/codingstyle.txt

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