Changes between Version 18 and Version 19 of Development/CodeConventions

Show
Ignore:
Timestamp:
03/16/10 07:14:47 (5 years ago)
Author:
benl (IP: 129.94.242.47)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Development/CodeConventions

    v18 v19  
    2222 
    2323 * 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 are defined in. 
     24 
     25 * Feel free to add dividers like: 
     26 {{{ 
     27 -- Optimiser Monad ----------------------------------------------------------------- 
     28 }}} 
     29 
     30 Such dividers increase the structure of the code and help the reader find things, especially with syntax highlighting editors. Most dividers should be 100 chars wide. If you want sub dividers then use 80 or 40 columns. If you have more than a few dividers in a module then consider breaking it up into smaller modules. 
     31 
    2432 
    2533=== Layout ===