In addition to item descriptions there will also be general information that cannot conveniently be codified directly in the source files. Automated scripts are used for parsing the source code and generating a database of key field types along with their descriptions and other identifying information. From this database a QuickView or HTML file can be generated using a script. Following these standards prevents script-busting problems from occuring. Carefully following the guidelines will allow us to meet this goal.
Any descriptions can consist of multiple lines and paragraphs.
The next line begins the next paragraph. Comments for the item are collected into paragraphs until the next section is detected. A description of a source code file will be encoded immediately after the copyright block. The description stops at the opening brace of the the class specification. The description should always contain the name of the class within the first few words of its text.