Was ist mit der Beschreibung von Classen/Interfaces/...?

[Josef Pötzl]

Was ist mit der Beschreibung von Classen / Interfaces / Methoden etc. mit:

Code: Alles auswählen

        /// <summary>
        ///  
        /// </summary>

[Josef Pötzl]

Das kann genutzt werden. Diese Einträge werden später mit Doxygen ausgewertet, um eine Projekt-Dokumentation zu erstellen.
Beispiel: SqlTools

[FireWalkerHH]

Uns, soweit ich weiß, werden diese Summary-Kommentare auch vom VisualStudio ausgewertet und in ToolTips angezeigt.

[KGunder]

D.h. es ist ok, wenn ich mal versuche zu allen vorhandenen Klassen / Procedure etc halbwegs sinnvolle Beschreibungen einzutragen?

[Josef Pötzl]

Das ist nicht nur ok, sondern wäre super.
... allerdings würde ich das nur bei öffentlichen Methoden empfehlen. Wenn man auch private Methoden so beschreibt, laufen wir Gefahr, dass die Beschreibung und die Aufgabe der Methode nach Überarbeitungen nicht mehr zusammenpassen. => In so einem Fall finde ich es besser, wenn man der Methode einen besseren Namen gibt, falls die Aufgabe nicht gut genug erkennbar ist.
Das gilt übrigens auch die die Namen der Klassen und Methoden. Falls jemand ein besserer Name einfällt, der die Aufgabe besser beschreibt ... nur keine Angst vor Änderungen.

Anm.: Ich werde dann demnächst auch noch versuchen die doxygen-Doku-Erzeugung so zu gestalten, dass die Doku automatisch erstellt wird. (Derzeit muss ich die html-Dateien noch manuell hochladen.)

Noch etwas:
Doxygen würde eine mehrsprachige Dokumentation erlauben.