Log In | Users | Register
Edit | Attach | New | Raw | Diff | Print | | Tools
You are here: Data » DocTools » CodeDocumentation

Documenting Code.

There are many obvious advantages of documenting code. Properly-documented code makes it easier to trace and squash bugs, to re-use and exchange code, to maintain it over the long run, and to improve both the scientific productivity and the code quality.

Here are some tools for automatic documentation of code.

Documentation from source code

A clever approach to documentation is to automagically generate code descriptions from the source code by applying standardized comments. There are several products available

For IDL, the software manufacturer proposes to documentation routines using standard headers. More spacer

This site is managed by the Center for Climate Systems Modeling (C2SM).
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems? Send feedback!