Comment (computer programming): Difference between revisions

Revision as of 11:28, 11 January 2025

Revision as of 11:33, 11 January 2025

Line 167:

</resource>

</syntaxhighlight>

=== Document development process ===

Sometimes, comments describe development processes related to the code. For example, comments might describe how to [[software build|build]] the code or how to submit changes to the [[software maintainer]].

=== Store metadata ===

Comments are used forcan store [[metadata]]. Sometimes,about athe [[softwarecode. maintainer]]For puts submission guidelines in comments to help people send improvements toexample, the maintainer.code Other common metadatamight includescontain 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> This may include insert positions for automatic header file inclusion, commands to set the file's [[syntax highlighting]] mode,<ref>{{cite book |last=Lamb |first=Linda |year=1998 |title=Learning the VI Editor |publisher=O'Reilly & Associates |___location=Sebastopol |isbn=978-1-56592-426-0 |url=https://archive.org/details/learningvieditor00lamb}} describes the use of modeline syntax in Vim configuration files.</ref> or the file's [[revision control|revision number]].<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>