| 

.NET C# Java Javascript Exception

3
Hallo,

ich bin gerade dabei eine Dokumentation für ein API Projekt umzusetzen. Diese würde ich am Ende gerne in HTML Form darstellen. Ich stelle mir das am Ende (rein optisch) etwa so vor.

Beispiel: Telerik Doku
http://docs.telerik.com/kendo-ui/php/widgets/barcode/overview


Beispiel MSDN
http://msdn.microsoft.com/en-us/library/System.String_methods(v=vs.110).aspx


Ich habe diverse Dinge überlegt wie z.B. die XML Dokumentationen der Klassen, Eigenschaften und Funktionen zu nutzen um daraus HTML Seiten zu generieren, dass aber als zu aufwendig eingestuft. Es gibt ja schon diverse Tools die das nur mit Hilfe der XML Dokumentation tun. Nur, möchte ich dazu noch Beispiele und umschweifende Texte schreiben würde ich mit mit dem Weg über die XML Doku ein wenig den Quellcode verstopfen. Lieber wäre mir daher eine Art Dokumentations CMS, dass sich nicht, bzw. nicht ausschließlich, aus dem tatsächlichen Quellcode generiert.
Gibt es zu dem Zweck Empfehlungen? Auch Stichwörter zur Suche würden mir schon weiterhelfen. Genauso wie die Info das ich total auf dem Holzweg bin :-)

Grüße
News:
16.09.2014
Slashi 409 2 8
3 Antworten
2
Leider hast Du die Sprache nicht angegeben, mit der Du Dein API erstellt hast. Oftmals sind die Tools auf eine oder mehrere Sprachen ausgelegt aber nicht allgemein einsetzbar.

Für C# gäbe es Sandcastle, mit welchem Du die XML-Kommentare nutzen, aber auch zusätzliche Seiten der Dokumentation hinzufügen kannst.
17.09.2014
Roland Bär 338 6
Mit dem Namen Sandcastle konnte ich auf jeden Fall gute (moderne und fortgesetzte) Alternativen finden. Danke!

http://stackoverflow.com/questions/8866598/good-alternatives-to-sandcastle-to-generate-msdn-style-documentation
Slashi 17.09.2014
0
Ich hätte jetzt mal so spontan an Docygen gedacht, sofern deine Sprache davon unterstützt wird.
16.09.2014
phg 1,6k 3
Dabei geht ja auch um ein Tool, welches einfach den Quellcode als Basis nutzt. Ich würde die Doku gerne manuell verfassen.
Slashi 17.09.2014
Eigentlich kann deine Dokumentation auch in externen Dateien liegen: "Flexible comment placement: Allows you to put documentation in the header file (before the declaration of an entity), source file (before the definition of an entity) or in a separate file."
phg 17.09.2014
0
Also ich kann HelpNDoc und GhostDoc (via NuGet) empfehlen.
17.09.2014
judgy 3,0k 1 1 8

Stelle deine Dokumentation-Frage jetzt!