Changes between Version 8 and Version 9 of DeveloperGuidelines/CodeConventions
- Timestamp:
- 04/20/10 10:02:23 (15 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DeveloperGuidelines/CodeConventions
v8 v9 1 [[TOC]] 1 2 DeveloperGuidelines 2 3 3 4 = Code Conventions = 4 5 5 These conventions should be followed in all code (mandatory for ucore): 6 These conventions should be followed in all code. 7 8 NOTE: These coding conventions are mandatory for code to be accepted for the UltraCore series! 9 10 == Code Style == 6 11 7 12 * http://code.google.com/p/soc/wiki/PythonStyleGuide 8 13 * 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]10 14 * Use " " for strings, UNLESS the string contains a ", in which case use ' 15 16 == Naming conventions == 17 11 18 * All functions outside of classes should have the prefix shn_<Model Name>_ 12 19 * 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 13 27 * Some automated bug analysis / code quality checking tools - 14 28 * [http://www.logilab.org/857 PyLint]