Comment (computer programming): Difference between revisions

Revision as of 11:37, 11 January 2025

Revision as of 11:42, 11 January 2025

Line 124:

}}</ref> Examples include [[Javadoc]], [[Ddoc]], [[Doxygen]], [[Visual Expert]] and [[PHPDoc]]. Forms of [[docstring]] are supported by [[Python (programming language)|Python]], [[Lisp (programming language)|Lisp]], [[Elixir (programming language)|Elixir]], and [[Clojure]].<ref>[https://clojure.github.io/clojure/clojure.core-api.html#clojure.core/defn Function definition with docstring in Clojure]</ref> [[C Sharp (programming language)|C#]], [[F Sharp (programming language)|F#]] and [[Visual Basic .NET]] implement a similar feature called "XML Comments" which are read by [[IntelliSense]] from the compiled [[.NET]] assembly.<ref>{{cite book|last=Murach|title=C# 2005|page=56}}</ref>

=== Include other informationVisualization ===

<!--This is not a good section grouping; but the info here is not grouped well; TODO separate & organize into cohesive sections -->

{{anchor|Resource inclusion}}

An [[ASCII art]] [[Data and information visualization|visualization]] such as a [[logo]], diagram, or [[flowchart]] can be included in a comment.<ref name="asciiart000">{{cite web

Line 136 ⟶ 134:

| url-status = dead

}}</ref>

<!--this belongs in the metadata section-->

A [[copyright]] notice can be embedded in a comment.

Binary data may also be encoded in comments through a process known as [[binary-to-text encoding]], although such practice is uncommon and typically relegated to external resource files.

The following code fragment depicts the process flow of a [[system administration]] script ([[Windows Script File|Windows script file]]). Although a section marking the code appears as a comment, the diagram is in an [[XML]] [[CDATA]] section, which is technically not a comment, but serves the same purpose here.<ref name="Niederst000">{{cite book

Line 167 ⟶ 160:

</resource>

</syntaxhighlight>

=== Store resource data ===

{{anchor|Resource inclusion}}

Binary data may also be encoded in comments through a process known as [[binary-to-text encoding]], although such practice is uncommon and typically relegated to external resource files.

=== Document development process ===