Sackville Development

Design principles

  • Provide a default configuration that will satisfy most user.
  • Do not overwhelm the user with too many configuration options.
  • Provide enough flexibility for advanced users.
  • Write code with extensibility and maintainability in mind.
  • Re-use existing libraries to extend functionality, where applicable.

Coding Style

  • Use 4 spaces for each level of indentation. Do not use tab characters. Most decent text editors should have a feature to insert spaces when you press the tab key.
  • Function names should begin with an uppercase letter.
  • Non-function variables should begin with a lowercase letter.
  • Use information hiding techniques (read more on this concept at http://en.wikipedia.org/wiki/Information_hiding)
  • Do not use "magic constants", which are defined as "Unique values with unexplained meaning or multiple occurrences which could (preferably) be replaced with named constants".
  • Please add comments to explain non-trivial code.
  • Use meaningful variable names

Comments

Posts Quoted:
Reply
Clear All Quotes