Comment (computer programming): Difference between revisions

Revision as of 11:33, 11 January 2025

Revision as of 11:37, 11 January 2025

Line 174:

Comments can store [[metadata]] about the code. For example, the code might contain the name of the original author and subsequent maintainers, dates when first written and modified, link to development and user documentation, and [[software license]] information.

Some [[programming tools]] write metadata into the code as comments.<ref>See e.g., {{cite book |last=Wynne-Powell |first=Rod |year=2008 |title=Mac OS X for Photographers: Optimized Image Workflow for the Mac User |page=243 |publisher=Focal Press |___location=Oxford |isbn=978-0-240-52027-8 |url=https://archive.org/details/macosxforphotogr0000wynn}}</ref> ThisFor may include insert positions for automatic header file inclusionexample, commands to set the file'sa [[syntaxversion highlightingcontrol]] mode,<ref>{{citetool bookmight |last=Lambwrite |first=Lindametadata |year=1998such |title=Learningas theauthor, VIdate Editorand |publisher=O'Reillyversion &number Associatesinto |___location=Sebastopoleach |isbn=978-1-56592-426-0file |url=https://archive.org/details/learningvieditor00lamb}}when describesit's thecommited use of modeline syntax in Vim configuration files.</ref> orto the file's [[revision control|revision number]]repository.<ref>See e.g., {{cite book |last=Berlin |first=Daniel |year=2006 |title=Practical Subversion, Second Edition |page=168 |publisher=APress |___location=Berkeley |isbn=978-1-59059-753-8}}</ref>

=== Syntax extension ===