Version 9 (modified by 15 years ago) ( diff ) | ,
---|
Table of Contents
Code Conventions
These conventions should be followed in all code.
NOTE: These coding conventions are mandatory for code to be accepted for the UltraCore series!
Code Style
- http://code.google.com/p/soc/wiki/PythonStyleGuide
- Limit line length to 80 characters
- Use " " for strings, UNLESS the string contains a ", in which case use '
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
- Some automated bug analysis / code quality checking tools -
- PyLint
- gives detailed report
- code quality score tells exact impact of the changes made
- http://www.logilab.org/card/pylint_tutorial
- PyChecker recommended in PythonStyleGuide
- PyLint
Note:
See TracWiki
for help on using the wiki.