User Tools

Site Tools


stephens_coding_standards

This is an old revision of the document!


Stephen's Coding Standards

Commented Code

No commented code, unless there is a comment clearly explaining under what circumstances the code should be uncommented. If there are no circumstances in which the code should be uncommented, it should be deleted.

Justification: Commented code adds no value to the source. It does not clarify or explain functionality. It is old rubbish that should be removed. Source control is for looking at old code.

Comments

Comments should be

  • complete sentences,
  • on their own line, at the current indent
  • grammatically correct, spelt correctly and have the correct punctuation (including a capital letter at the start and a full stop at the end).

Names

Developer names should not appear in code.

Justification: The code belongs to the company not the individual developers that wrote it. Names in code encourages an attitude of certain developers 'owning' certain parts of the code or particular parts of functionality of the system. It also discourages other developers from changing the code due to a fear of standing on someone's toes. At TallGuyProgramming Inc, all developers are free to change any part of the code and developer specialisation is strongly discouraged.

stephens_coding_standards.1332189376.txt.gz · Last modified: 2017/01/01 19:53 (external edit)

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki