Recommended Coding Practises

To make the various routines and procedures easier for both the users and programmers to read and understand it is very helpful if some basic, simple coding practises are followed.

The recommended coding practises are divided into the following topics:

• Documenting the Code
• DOXYGEN
• Variable Names

Documenting the Code

Put comments in your code describing what the code is supposed to be doing at every step. Identify and describe the variables used.

DOXYGEN

DOXYGEN is an automated documentation application. It scans files and extracts information about the class, functions, namespaces, etc. used in routines and generates HTML output.

Variable Names

By following some simple rules in selecting and using variable names the code can be made much more readable.