Dokumentation: Unterschied zwischen den Versionen

Aus Das Sopra Wiki
Dietsch (Diskussion | Beiträge)
Dietsch (Diskussion | Beiträge)
Zeile 9: Zeile 9:


=== Kommentare in C# und Doxygen ===
=== Kommentare in C# und Doxygen ===
C# und Visual Studio bieten verschiedene Möglichkeiten an, Kommentare zu verfassen. Neben den ''einzeiligen Kommentaren'', die nur für kurze Anmerkungen verwendet werden sollten, gibt es noch ''mehrzeilige Kommentare'' oder ''XML Kommentare'', mit denen sich der Quellcode gut dokumentieren lässt.
{{CSharp}} und [[Visual Studio]] bieten verschiedene Möglichkeiten an, Kommentare zu verfassen. Neben den [[#Einzeilige Kommentare|''einzeiligen Kommentaren'']], die nur für kurze Anmerkungen verwendet werden sollten, gibt es noch [[#Mehrzeilige Kommentare|''mehrzeilige Kommentare'']] und [[#XML Kommentare|''XML Kommentare'']], mit denen sich der Quellcode gut dokumentieren lässt.


==== Einzeilige Kommentare ====
==== Einzeilige Kommentare ====
Zeile 21: Zeile 21:
</source> [[Kategorie:Code-Beispiele]]
</source> [[Kategorie:Code-Beispiele]]


==== Abgegrenzte Kommentare ====
==== Mehrzeilige Kommentare ====
{{BA|Jeremi|im englischen: "delimited comments"}}
{{BA|Jeremi|im englischen: "delimited comments"}}
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>).
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>).