Menu

[r40]: / wiki / CodingStyleRules.wiki  Maximize  Restore  History

Download this file

21 lines (19 with data), 1.1 kB

#summary Describes the coding style rules we follow

=Rules?=
Like any other open-source project we have setup some 'Coding Style Rules' to prevent the code from becoming a mess. There may seem to be a lot of rules, but a great part of it is pretty standard.

  * We work object-oriented
  * All classes should be re-usable
  * A tab width is 4
  * Do not create new variables if not neccesary
  * Keep your code small but effective
  * Always add comments and documentation
  * Keep function and variable names descriptive
  * Form elements names should be written as Type_Name
     For example: TextBox_Phonenumber
  * Use error handeling by creating exceptions in the exceptions class
  * Test your code before submitting
  * Never delete code from somebody else, simply comment it to prevent execution.
  * Add your self to the credit list on top of the file when you contributed to it.
  * Use shortening of if/for/while/foreach statements whenever possible.
  * HTTP request need to be made Asynchronously or in a seperated Thread
  * Unsafe threading is allowed as long as correct error handeling is used
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.