XML-Dokumentation von C# erstellen?
-
Hi,
ich habe hier einen Code den ich Dokumentieren soll. Jetzt habe ich erfahren, dass ich mit VS .NET die Möglichkeit habe eine XML-Doku zu erstellen.
Ich habe mich mal auf der msdn Seite und auch in der Hilfe von VS .NET umgesehen und habe lauter XML-Tags gefunden, die jedoch zum größten Teil nicht von der erstellten Dokumentation übernommen werden.
Z.B funktionieren die Tags:
summary, return, param, jedoch nicht:
para, value, example, uvm..
Mache ich etwas falsch bei der Erstellung der Doku oder wieso funktionieren die nicht? Habe versucht eine Doku vom MSDN Beispielcode zu erstellen, leider ohne Erfolg.
Kann mir da einer weiterhelfen?
-
Mit was bzw. wie hast Du es denn versucht? Schau Dir mal das Programm NDoc an.
-
Habe es mit VS .NET erstellt. (Extras->Erstellen von Kommentarwebseiten...) sollte eigentlich gehen. Die Beispiel Dokumentationen auf der MSDN Seite wurden auch mit Tags kommentiert, wenn ich dann aber aus dem kommentierten Beispielcode eine Doku erstelle sind meistens die Tags nicht verarbeitet.
NDoc ist doch ein externes Tool, ist das für Unternehmen kostenpflichtig?
-
also erstmal Ndoc ist OpenSource genauer gesagt GPL ... also du mußt den Code nur frei zu verfügung stellen wenn du wenn du was an NDoc ansich machst...
Es gibt noch ein Programm nennt sich vbcommenter läßt sich in VS einbinden und funktioniert ,genauso wie der C# compiler, für Visual Studio und dann kannst du die erhaltene XML DAtei mittels Ndoc verarbeiten... geht eigentlich ganz gut...
-
Habe es auch mit NDoc versucht aber er reagiert genauso wenig auf die Tags wie VS. NET.
Woran kann das leigen fehlen mir da paar Libs oder so?
-
Zeig mal den Source. Bei mir funktionieren die mit dem VS und mit NDoc.
-
Die XML DAtei erstellt dein Compiler aber schon???
Hast du eigene TAgs geschrieben oder benutzt du die TAgs die deine VS automatisch erstellt wenn du "///" schreibst?
Mit denen sollte es eigentlich funktionieren...DAnn Compilieren und du solltest bei deinem Assembly die XML DAtei haben... die du dir mit dem IE anschauen kann( oder was auch immer)
dann einfach in das NDOC bei Add: Assembly und die XML DAtei...
und dann bei Docu Type einen einstellen... MSDN meinetwegen ...oder dann laufen lassen das sollte eigentlich funktionieren( nur halt nicht XML DOCU... weil dann wärst du nicht weiter als vorher) :p
-
Also mit VS. NET funktioniert es immer noch nicht. Er versteht anscheinend nicht die Tags. Mit NDoc mußte ich ein Plugin downloaden "MSDN DE" für die deutsche Hilfe.
Aber ich glaube den Tag <c> erkennt er zumbeispiel nicht. Die XML-Datei wird von VS .NET erstellt ohne Probleme.
MFG
Olimlad
-
Ich habe auch VS.NET ( 2003 ) und bei mir funktionieren Tags wie: "param, value, example".