Changes between Version 8 and Version 9 of DeveloperGuidelines/CodeConventions


Ignore:
Timestamp:
04/20/10 10:02:23 (12 years ago)
Author:
Dominic König
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DeveloperGuidelines/CodeConventions

    v8 v9  
     1[[TOC]]
    12DeveloperGuidelines
    23
    34= Code Conventions =
    45
    5 These conventions should be followed in all code (mandatory for ucore):
     6These conventions should be followed in all code.
     7
     8NOTE: These coding conventions are mandatory for code to be accepted for the UltraCore series!
     9
     10== Code Style ==
    611
    712 * http://code.google.com/p/soc/wiki/PythonStyleGuide
    813  * Limit line length to 80 characters
    9  * All files, classes and functions should have docstrings which allow to auto-generate API documentation using [http://epydoc.sourceforge.net epydoc]
    1014 * Use " " for strings, UNLESS the string contains a ", in which case use '
     15
     16== Naming conventions ==
     17
    1118 * All functions outside of classes should have the prefix shn_<Model Name>_
    1219 * All classes which over-ride existing classed should have the suffix "S3"
     20
     21== Comments and DocStrings ==
     22
     23 * All files, classes and functions should have docstrings which allow to auto-generate API documentation using [http://epydoc.sourceforge.net epydoc]
     24
     25== Tools ==
     26
    1327 * Some automated bug analysis / code quality checking tools -
    1428   * [http://www.logilab.org/857 PyLint]