Benutzerdokumentation aus Kommentarblöcken generieren

Moin Leute

Ich höre jetzt schon das Aufschreien: "Schon wieder Doku aus Code generieren". Ja, und nein. Ich bin jetzt seit drei Stunden auf der Suche und habe nicht das passende gefunden.

Was möchte ich nicht dokumentieren:

APIs
Klassen
SourceCode
Funktionen
Datenbankstrukturen

Was möchte ich dokumentieren:
Die Funktion meiner Anwendung. Auf ein Edit gehen und F1 drücken und gut. Nur möchte ich nicht in irgendeinem Programm meinen Senf abladen, sondern direkt im Code schreiben, dort wo das ganze Umgesetzt ist.

Was habe ich nicht für Programme gefunden:

Sandcastle
Doxygen
VSdocman
NDoc
nonodoc
GhostDoc

Es wirkte alles auf mich, dass ich damit nur mein Projekt oder den Code dokumentieren kann. Ich möchte einfach nur ein HTML-Dokument haben, dass ich nach meinen Wünschen in Reihenfolge und Aussehen bestimmen kann.

Kann mir da jemand helfen?

Hi MacGuyver,

du verwechselst Code-Dokumentation mit Anwendungs-Dokumentation. Die Code-Dokumentation ist für die Entwickler und die Anwendungs-Doku ist das Handbuch für den Anwender. Beide haben komplett unterschiedliche Zielgruppen und Anforderungen.

Online-Hilfen und Handbücher werden daher auch nie von den Entwicklern geschrieben. Und vor allem nicht im Code.

Tja, sag niemals nie. Meine kleine Anwendung, die nur im Haus läuft, soll ich auch dokumentieren. Von daher ist mir aber klar, warum es da nichts gibt, weil es kaum jemand macht.

Das ist auch total unschön, wenn man im Code aufwändige Beschreibungen (in 1 Sprache) hinzufügt, da besteht der Code zur Hälfte aus Anwendertutorials.... Nein bitte nicht..

Zudem muß dann nicht mal alles Dokumentiert werden oder umgekehrt, Dinge die fachlich wichtig sind, aber technisch nichts voneinander wissen.

Das wäre dann ein Hexeneintopf mit Zutaten, die man noch nie gehört hat. 😉

Gemacht wird das schon.
Nur nicht von den Entwicklern im Code.

Hallo,

mit Ghostdoc und Sandcastle konnte man 'imho' eine Art "F1-Hilfe" erstellen.

Siehe hierzu
Ghostdoc und Sandcastle

Im Beitrag sind auch ein paar interessante Links gewesen, vielleicht ist es das was du suchst.

Dort ist aber die Funktionalität innerhalb vom Visual Studio gemeint (also für andere Entwickler), nicht innerhalb des laufenden Programms für die Benutzer (Endanwender).

Für Endnutzerdokumentationen ist der Code - wie schon so häufig gesagt - der völlig falsche Punkt.
Dafür verwendet man Redaktionssysteme.