• Das Doku-Kommentar beginnt mit /// (3), anstatt // (2) • Stehen nur Klassen, Felder/Eigenschaften und Methoden • Das Kommentar steht dabei immer direkt u ¨ber den zu kommentierenden Code
• Man kann aus diesen eine Dokumentation generieren • Außerdem k¨ onnen einige IDEs (z.B. Visual Studio) daraus eine Kurzbeschreibung der Elemente w¨ahrend des Programmierens schaffen
2
Dokumentationskommentare
Tags • Sind Teil eines Dokumentationskommentars • Geben an, was genau von dem Code dokumentiert werden soll • 3 wichtige Tags: summary Beschreibung des zu kommentierenden Codes F¨ ur alle 3 Arten ¨ param Beschreibung der Ubergabeparameter einer Methode returns Beschreibung des R¨ uckgabewertes einer Methode • Hier findet man weitere Tags
3
Dokumentationskommentare
• Die genannten Tags am Beispiel einer Methode: 1 2 3 4 5 6 7 8 9 10
// / < summary > // / Die Beschreibung der Methode // / // / < param name =" erster " > U e b e r g a b e p a r a m e t e r 1 // / < param name =" zweiter " > U e b e r g a b e p a r a m e t e r 2 // / < returns > Beschreibung des Ausgabewertes public int EineMethode ( int erster , int zweiter ) { // Code }
4
• Und nun mit Inhalt: 1 2 3 4 5 6 7 8 9 10 11 12
// / < summary > // / Eine einfache Addition zweier Zahlen . // / // / < param name =" a " > der erste Summand // / < param name =" b " > der zweite Summand // / < returns > die Summe public int Addition ( int a , int b ) { int sum = 0; sum = a + b ; return c ; }
5
G¨ ultigkeit (Scope)
G¨ ultigkeit (Scope)
• Variablen, Member, Klassen und andere Elementen sind nur innerhalb eines bestimmten Bereichs g¨ ultig: • Methoden und Felder nur in deren Klassen • Parameter nur in deren Methoden • Lokale Variablen innerhalb ihrer Bl¨ ocke
• Dieser Bereich ist definiert durch die Position an denen sie deklariert wurden
6
G¨ ultigkeit (Scope)
1 2 3 4 5 6 7
int eineVariable = 7; for ( int zaehler = 0; zaehler < 9; zaehler ++) { // zaehler und einString sind bloss in diesem Block // nutztbar , aber nicht ausserhalb . string einString = " Hallo " ; }
