Größeres Projekt richtig kommentieren

Hi!

Ich habe ein größeres Projekt unter .NET mit C# am laufen. Und jetzt kommt langsam der Punkt wo ich selber nicht mehr genau verstehe wie alles genau funktioniert Dem will ich entgegen wirken indem ich die einzelnen Teile des Projekts kommentiere.

Da gibt es ja unter .NET die Möglichkeit das ganze mit vordefinierten XML-Kommentaren zu machen. Dazu habe ich allerdings eine Frage und zwar verstehe ich (auch nachdem ich auf MSDN nachgelesen habe) nicht, mit was man ganz stinknormalen Code beschreibt. Nimmt man dafür auch <summary>? Ich habe es so aufgefasst als ob <summary> nur für Objekte ist. Stimmt das?
Welches XML-Element benützt man um ein paar Zeilen Code zu beschreiben, die nicht ein Objekt darstellen?

Ich hoffe ihr versteht mein Anliegen. Vielen Dank und ebenso viele Grüße, Sammy

Hallo

Grundsätzlich versthe ich nicht ganz, was du meinst, aber zum dokumentieren kann man auch addinn a la ghostdoc verwenden und die Kommentare noch etwas anpassen. Dann kannst du mittels sandcastle und sandcastle file build helper aus den xml Dateien schöbe Dokus a la msdn machen.

chrische

Hi!

Danke für deine Antwort. Mich verwirrt, dass hier(http://msdn2.microsoft.com/de-de/library/5ast78ax.aspx) steht wie man Code in einem Kommentar auszeichnet, oder wie man Objekte auszeichnet. Aber es gibt z.B. keine Elemente für Methoden oder Variablen.

public class Test
{
        /// <summary>
        /// Blabla - Funktion Klasse beschreiben und so
        /// </summary>

        private string testStr = null; 
        private void tester()
        {
               Do.Something(stupid);
        }
}

Mit welchen XML-Elementen kann ich jetzt z.b. testStr und tester() beschreiben? Was wähle ich dazu? Auch <summary>?

Viele Grüße,
Sammy

PS: Deinen Vorschlag mit dem Add-In werde ich mir auch näher anschauen. Danke!

Nein, der Kommentar steht immer über das zu beschreibende Teil, in diesem Fall dokumentierst Du testStr. Mach doch mal eine Funktion mit einer größeren Signatur und gebe direkt über der Funktion die drei Slashes ein, er müsste dann von selbst das Dokumentationsgerüst für Argumente, Rückkehrwerte usw einfügen.

///
private void tester()
{

Ha, wie geil!

Danke schön! Vielen Dank!