XML Dokumentation in VS 2005

[yan1]

Hi,

ich möchte ein Projekt nach der (fast) Fertigstellung nun ausreichend Dokumentieren.
Die XML Dokumentation von VS 05 gefällt mir so weit ganz gut, vor allem kann ich daraus eine schöne HTML Dokumentation mit dem Entsprechenden Tool machen.

Nur mein Problem: Ich möchte meine ganzen Klassen und Methoden nicht direkt im Quellcode dokumentieren, Beispiel:

        /// <summary>
        /// Diese Methode gibt einen leeren String zurück :-P
        /// </summary>
        /// <param name="blub">der Parameter ist eigentlich umsonst</param>
        /// <returns>Leerer String</returns>
        string MeineMethode(string blub)
        {
            return "";
        }

Wenn ich nämlich alle Methoden ausreichend dokumentiere, werden die Dokumentationen länger als der eigentlich Code...

Gibt es da keine Möglichkeit externe "Dokumentationsdateien" zu machen? Ich habe im VS noch nichts passendes gefunden...

weiss da wer was?

 

[Christian Kusmanow]

Soweit ich weiss geht das nicht. Vielleicht weiss das ja wer...

Zudem finde ich, dass das nicht besonders praktikabel ist,
weil jemand der sich darin einlesen muss ständig zwischen Code und Doku wechseln müsste.

Btw. das VS bietet die funktionalität alle Code-Elemente zu "collapsen".
Rechtsklick auf den Code, Outlining->Collapse to Definitions.

MfG,
cosmo

 

[yan1]

Ja das ist klar, aber das muss ich nach jedem "Projekt Öffnen" wieder neu machen.
Ich finde es nicht unpraktisch, derjenige der die Dokumentation verändern will muss halt einmal in die Doku datei wechlsen, und derjenige, der die Dokumentation verwenden will, bekommt sowiso nicht die XML Dateien vorgesetzt, sondern die fertige Windows Hilfe Datei oder eine html Seite, die ausschaut wie die MSDN