wiki:DeveloperGuidelines/CodeConventions

Version 11 (modified by Fran Boon, 12 years ago) ( diff )

--

DeveloperGuidelines

Code Conventions

These conventions should be followed in all code.

NOTE: These coding conventions are mandatory for code to be accepted for the Stable series!

Code Style

Naming conventions

  • All functions outside of classes should have the prefix shn_<Model Name>_
  • All classes which over-ride existing classed should have the suffix "S3"

Comments and Docstrings

  • All files, classes and functions should have docstrings which allow to auto-generate API documentation using epydoc

Tools

DeveloperGuidelines

Note: See TracWiki for help on using the wiki.