Skip to content

Prefered Coding Style

darksideprogramming edited this page Apr 27, 2015 · 2 revisions

The goal in the code of LineFit is to make everything as obvious as possible and to make things well documented. Here are a few suggested to accomplished this:

  • long but clear variable names - we don't need to save space these days...
  • Use correct indentation and put brackets on their own lines, not appended to the end of if statements
  • JavaDoc comments on all classes, functions and variables. If you don't know how to do them, just look at the rest of the code
  • in line comments that explain how you are doing anything that may be confusing or that are not intuitive
  • Try not to let your functions grow too long
  • Update the user documentation or this wiki if things have changed!
  • Document, document, document - you can have the best code in the world but if no one understands it, it will be unmaintainable.

Clone this wiki locally