Kommentar (datalogi)

En illustration af Java kildekode med **prolog** kommentar indikeret med rød og **inline** kommentarer med grøn. **Programkoden** er med blå.

Indenfor datalogi (især i programmering og konfiguration) er en kommentar en menneskelæsbar forklaring eller anmærkning i kildekoden eller konfigurationsfilen. Kommentarer tilføjes med formålet at gøre dem lettere for mennesker at forstå - og kommentarer bliver almindeligvis ignoreret af oversættere og fortolkere.^[1]^[2] Kommentarers syntaks varierer meget med forskellige programmeringssprog og program konfigurationsfiler.

Kommentarer bliver nogle gange også behandlet på forskellige måder for at generere dokumentation eksternt fra kildekoden. Denne behandling foretages af dokumentationsgeneratorer - eller anvendes til integration med versionsstyringssystemer og andre slags eksterne programmeringsværktøjer.

Referencer

^ Penny Grubb, Armstrong Takang (2003). Software Maintenance: Concepts and Practice. World Scientific. s. 7, plese start120–121. ISBN 978-981-238-426-3.
^ For purposes of this article, programming language comments are treated as indistinct from comments that appear in markup languages, configuration files and other similar contexts. Moreover, markup language is often closely integrated with programming language code, especially in the context of code generation. See e.g., Ganguli, Madhushree (2002). Making Use of Jsp. New York: Wiley. ISBN 978-0-471-21974-3., Hewitt, Eben (2003). Java for Coldfusion Developers. Upper Saddle River: Pearson Education. ISBN 978-0-13-046180-3.

Yderligere læsning

Movshovitz-Attias, Dana and Cohen, William W. (2013) Natural Language Models for Predicting Programming Comments. In Association for Computational Linguistics (ACL), 2013.

Eksterne henvisninger

How to Write Comments by Denis Krukovsky
Source Code Documentation as a Live User Manual by PTLogica
How to Write Comments for the Javadoc Tool
Doxygen, a documentation system for C, C++, Java, Objective-C, Python, IDL and to some extent PHP, C#, and D

Spire

Denne artikel om datalogi eller et datalogi-relateret emne er en spire som bør udbygges. Du er velkommen til at hjælpe Wikipedia ved at udvide den.

[PennyGrubb000-1] Penny Grubb, Armstrong Takang (2003). Software Maintenance: Concepts and Practice. World Scientific. s. 7, plese start120–121. ISBN 978-981-238-426-3.

[2] For purposes of this article, programming language comments are treated as indistinct from comments that appear in markup languages, configuration files and other similar contexts. Moreover, markup language is often closely integrated with programming language code, especially in the context of code generation. See e.g., Ganguli, Madhushree (2002). Making Use of Jsp. New York: Wiley. ISBN 978-0-471-21974-3., Hewitt, Eben (2003). Java for Coldfusion Developers. Upper Saddle River: Pearson Education. ISBN 978-0-13-046180-3.

[1]

[2]