Comment (computer programming): Difference between revisions

Content deleted Content added
add copyright
Line 120:
===Support documentation generation===
 
An [[API]] [[documentation generator]] parses information from a codebase to generate API documentation. Many support reading information from comments, often parsing metadata, to control the content and formatting of the resulting document. Some

Although some claim that API documentation can be higher quality when written in a more traditional and manual way, some claim that storing documentation information in code comments simplifies the documenting process, as well as increases the chanceslikelihood that the documentation will be kept up to date.<ref name="Ambler000">{{cite book
| title=The Object Primer: Agile Model-Driven Development with UML 2.0
| first=Scott