Changes between Version 5 and Version 6 of Development/CodeConventions

Show
Ignore:
Timestamp:
08/27/09 13:05:01 (5 years ago)
Author:
benl (IP: 219.127.83.145)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Development/CodeConventions

    v5 v6  
    1313 * Running comments in the bodies of functions are encouraged. Write down what you were expecting the code to do when you wrote it, so it reads like a story. Aim for about 1 comment line every 5-10 code lines, depending on how complex the code is. 
    1414 
    15  * If a function does several things in a regular way, then it should look like that in the source code. This means you should line up arguments to similar function calls. For example, use this 
     15 * If a function does several things in a regular way, then it should look like that in the source code. This means you should line up arguments to similar function calls. For example, use this: 
    1616{{{ 
    1717 = do   someFunction      "Monday"    (23, 23)         (Just 'a') 
     
    2020}}} 
    2121 
    22  instead of this 
     22 instead of this: 
    2323    {{{ 
    2424 = do   someFunction "Monday" (23, 23) (Just 'a') 
     
    2626        anotherFunction "Wednesday" ('a', 'b')  
    2727   }}} 
     28 
     29 * All top-level bindings should have a type signature. Exceptions can be made for functions that are continuations of others, as they will never need to be called from outside the module they were defined in. 
    2830 
    2931[[br]]