An important aspect is documentation of the file or module as a
whole, explaining its design, purpose and relation to other modules. In
JavaDoc this is the comment that preceeds the class definition. The
Prolog equivalent would be to put the module comment in front of the
module declaration. The module declaration itself however is an
important index to the content of the file and is therefore best kept
first.
The general comment-structure for module comments is to use a type
identifier between angled brackets, followed by the title of the
section. Currently the only type provided is module. Other
types may be added later.
Example
/** <module> Prolog documentation processor
This module processes structured comments and generates both formal
mode declarations from them as well as documentation in the form of
HTML or LaTeX.
@author Jan Wielemaker
@license GPL
*/
