next up previous contents index
Next: Documentation Up: Code Standards Previous: Installation

    
Code Documentation

Proper documentation  and comments in the application code itself are essential. As an absolute minimum of documentation in the code, each module must contain the elements below: Usage of meaningful names of variables and functions is recommended to improve readability of the code. Although the exact amount of comments compared to the code will depend on the actual module, a general guideline is that approximately 30% of a module should be comments.


next up previous contents index
Next: Documentation Up: Code Standards Previous: Installation
Send comments to web@eso.org
Last update: 1998-10-23