Wozu sind die "///-Kommentare" gut?

Hallo!

Ich bin gerade über die XML-Kommentare, die über /// eingefügt werden können gestolpert. Kann mir einer von euch erklären, wozu die gut sind? Das hab ich leider noch nirgends gefunden, Google war da auch nciht mein freund.

Wann sollten diese Kommentare unbedingt rein, wann kann man sie rein machen und wann sollte man sie lieber draußen lassen?

Gruß Patrick

Wenn ich dich richtig verstanden habe meinst du die Kommentare,

wenn du /// im Visual Studio eingibst, das es automatisch einen "Rumpf" generiert der etwa so aussieht:

    /// <summary>  
    /// Beschreibung  
    /// </summary>  
    /// <returns>Was es zurück liefert</returns>  

Was das bringt ist ganz einfach:

Mach dir mal ne Klasse, deklariere ne öffentliche Methode und da fügst du mal obiges ein!

Dann verwendest du die Klasse in deinem Programm schreibst z.b. "Klassenname". dann springt intelisense auf und hier wird dir bei deiner Methode der obige Text ausgeben, is sozusagen ne Hilfe!

Hallo,

diese Kommentare werden von IntelliSense ausgewertet. Also, wenn du Console.WriteLine( schreibst, taucht ja die Liste der möglichen Parameter auf und die Beschreibung dazu.

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

Danke!
Jetzt hab ich das verstanden.

Gibt es irgendwelche Bestimmungen für die Angabe des Return-Werts oder kann ich da quasi auch Prosa rein schreiben?

Gibt es noch weitere mögliche Angaben?

Gruß Patrick

Diese Kommentare werden gefolgt von tags z.b. <summary>. Oder auch die <param> welche die Parameter einer Methode beschreiben. Es gibt tools wie z.b. docomatic oder sandcastle welche aus diesem Tags ein Helpfile für Entwickler generieren. Ein sogenanntes chm file. Zum Sandcastle gibt es ein gereration tool und eine GIU CHM-Builder. Nicht erschrecken, die gerneration befarf einiger Zeit und wird unterwegs in etlige formate umconvertiert ehe es ein chm file raus kommt. Ich hoffe ich konnte helfen.

wiki

Gibt es irgendwelche Bestimmungen für die Angabe des Return-Werts oder kann ich da quasi auch Prosa rein schreiben?

solange "prosa" sinn ergibt, kannst du es reinschreiben.

Gibt es noch weitere mögliche Angaben?

das kannst du alles in der MSDN nachlesen.

solange "prosa" sinn ergibt, kannst du es reinschreiben.

Mit dem Prosa meinte ich halt, dass ich net nur den Datentyp reinschreiben darf, sondern auch noch bissel ne Beschreibung.
Als Beispiel ne funktion, die mir nen Liefertermin berechnet und dann diesen als DateTime zurück gibt könnte ich dort reinschreiben "DateTime, errechneter Liefertermin"

das kannst du alles in der MSDN nachlesen.

Hab ich dann auch gemerkt, als ich den Beitrag erstellt hatte.

Nochmal Danke für eure Hilfe!

Gruß Patrick

Es ist ja auch für die Beschreibung gedacht. Datentypen werden vom Intellisence auch dann angezeigt wenn du keine XML-Kommentare schreibts

den datentyp solltest du in der beschreibung explizit nicht erwähnen. allerhöchstens nur einen möglichen wert. im falle von returndatentyp bool könnte man schreiben: "True if no error detected"

damit weiß man gleich was mit dem rückgabewert anzufangen ist.

Um ein Gefühl dafür zu bekommen, wie ausführlich (oder auch nicht) diese Kommentare sein sollten, kannst du ja einfach mal schauen, wie Microsoft seine Klassen so dokumentiert hat. Einfach mal per IntelliSense durch Framework "browsen". 😉

/Edit: Vielleicht interessiert dich auch das hier: Richtlinien für Kommentare

Hallo herbievore!

Tut mir leid, aber zur Zeit ist meine Hauptarbeit nicht .net sondern noch die Entwicklung in Visual FoxPro. Ich komme nur alle paar Tage dazu mich mit C# und .net zu beschäftigen und habe auch langezeit gar nichts damit gemacht. Deshalb bin ich schon so lange angemeldet und hab noch einige sachen nicht drauf. Ich bezeichne mich ja selber noch als blutigen Anfänger.

Gruß Patrick

Dafür ist das Forum ja auch da!

Egal wie lange man schon "dabei" ist!