Dokumentation: Unterschied zwischen den Versionen

{{UEA|Jeremi|Dieser Artikel wird gerade erstellt. Bitte haben Sie etwas Geduld. :)}}

{{BA|Jeremi|Hier kurze Einleitung}}

...

[[Visual Studio]] bietet verschiedene Möglichkeiten, Kommentare zu verfassen. Neben den ''Inline Kommentaren'', die nur für kurze Anmerkungen verwendet werden sollten, gibt es noch ''mehrzeilige Kommentare'' und ''XML Kommentare'', mit denen sich Meth

Einzeilige Kommentare beginnen mit zwei Slashes und enden automatisch am Ende der Zeile:

</source>

Ein Stern nach einem Slash (<code>/*</code>) leitet einen Kommentarblock ein. Der Kommentar endet erst, wenn das das entsprechende Token zum beenden des abgegrenzten Kommentars gefunden wurde (<code>*/</code>).

</source>

...

Visual Studio kann in Kommentaren nach bestimmten Token suchen und diese dann in der [[Task List]]e gesammelt anzeigen. So können zum Beispiel Codestellen markiert werden, die noch einer Bearbeitung bedürfen. Vordefinierte Token sind ''TODO'', ''HACK'' und ''UNDONE''. Ein Token muss immer direkt hinter den Zeichen stehen, die den Kommentar einleiten.

Es können auch eigene Token erstellt werden.<ref>http://msdn.microsoft.com/en-us/library/zce12xx2(VS.80).aspx Mircrosoft Msdn Library - How to: Create Task List Comments</ref> [[Kategorie:Code-Beispiele]]

Wird ein Programm wie [[Doxygen]] verwendet, um aus dem Source Code automatisiert eine Dokumentation zu generieren, so können in den Kommentaren noch zusätzlich ''Special Commands''<ref>http://www.stack.nl/~dimitri/doxygen/commands.html Doxygen Manual - Special Commands</ref> verwendet werden. Mit ihnen lassen sich zum Beispiel der Text formatieren oder man kann bestimmte Meta Informationen zum Code mitgeben.

...

Kommentieren ist schön und gut, aber wann genau soll nun kommentiert werden? Es gibt mehrere Ansätze, Kommentare zu verfassen, die auch von dem jeweiligen Programmierstil abhängen.