Changes between Version 33 and Version 34 of Development/CodeConventions


Ignore:
Timestamp:
Dec 5, 2012, 12:06:20 PM (6 years ago)
Author:
benl
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Development/CodeConventions

    v33 v34  
    44The golden rule is to follow whatever conventions are already being used in the module you're editing. If you're creating a new module then follow the conventions used in existing modules.
    55
    6 If you're not sure what the conventions are, then ask. If you can think of a better way of doing it then let us know on the mailing list. This goes for use of library functions as much as formatting and commenting style. The DDC project was started some time ago, and times change...
     6If you're not sure what the conventions are, then ask. If you can think of a better way of doing it then let us know on the mailing list. This goes for development process and the use of library functions, as much as formatting and commenting style. The DDC project was started some time ago, and times change...
    77
    8 However: we try to avoid having multiple competing coding styles in DDC. Having different styles creates "accidental complexity", that is, syntactic differences in the source that don't equate to real functional differences. If we change conventions then they should be documented so the we can migrate the code base towards using them.
    9 
    10 [[br]]
    118== General Rules for all Languages ==
    129
     
    3532
    3633=== Layout ===
     34 * We try to avoid having multiple  competing layout styles in DDC. Having different styles creates "accidental complexity", that is, syntactic differences in the source that don't equate to real functional differences. If we change styles then they should be documented so the we can migrate the code base towards using them.
     35
    3736 * 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:
    3837{{{