Comment (computer programming): Difference between revisions

Content deleted Content added
Comment out: clarify
Documentation generation: use verb phrase to match other section; clarify the type of doc generator
Line 113:
Many IDEs support adding and removing comments with convenient [[user interface]] such as a [[keyboard shortcut]].
 
===DocumentationSupport documentation generation===
 
AAn [[API]] [[documentation generator]] can parseparses information from a codebase to generate API documentation. Many support reading information from comments to control the content and formatting of the resulting document. Some claim that storing documentation information in code comments simplifies the documenting process, as well as increaseincreases the chances 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