647
edits
Changes
Jump to navigation
Jump to search
Line 34:
Line 34: + + + +
Development Team/Code guidelines (view source)
Revision as of 04:42, 7 August 2009
, 04:42, 7 August 2009no edit summary
Use inline comments sparingly. If you feel your code needs an inline comment, consider instead splitting the method in two, with a reasonable name and API comment. API comments should say '''what''' the code does, not '''how''' it does it. How your code works should be clear from the code structure, refactor until the code structure is a clear reflection of its purpose.
Use inline comments sparingly. If you feel your code needs an inline comment, consider instead splitting the method in two, with a reasonable name and API comment. API comments should say '''what''' the code does, not '''how''' it does it. How your code works should be clear from the code structure, refactor until the code structure is a clear reflection of its purpose.
= Tools =
When possible use tools to check your code, this will save lots of time to everybody involved. We recommend pylint and pep8.py, would also welcome feedback about pyflakes.