Dokumentationswerkzeug

[Gateway_man]

Hallo,

ich bin mir nicht sicher wo ich es reinpacken soll (gehört für mich jetzt nicht zu Anwendungssoftware). Verschiebt es bitte wenn ich es in der falschen Rubrik erstellt habe.

Ich suche nach einem Produkt (einer Website) die es mir erlaubt Klassen und deren member zu beschreiben.

Im Prinzip genauso etwas wie die MSDN. Kann gerne etwas kosten, aber es wäre notwendig das man Zugriff auf den Quellcode für das Projekt erhält, sodass man es erweitern/ändern kann.

Ist jemandem so etwas bekannt?

Optimaler weise ASP.NET, PHP wäre aber auch nicht schlimm.

Mein Problem ist, ich weiß nichtmal unter was für einer Begrifflichkeit ich bei Google suchen soll. Auf keinen Fall soll es ein Wiki sein. Ich check die Nutzung dieser Teile bis heute nicht. Für mich total unübersichtlich.

Ein Suchfeld irgendwo oben und ansonsten links ein treeview mit den Technologien bzw. geschachtelt den Klassen und rechts die Beschreibungen.

LG

Gateway

[Pixie]

Ein paar Verständnisfragen...

Sandcastle und DocumentX kennst Du, aber sie kommen nicht in Frage, weil das Ergebnis im Inter-/Intranet bearbeitbar zur Verfügung stehen soll?

Sollen Inhalte automatisch (aus XMLKommentaren) erstellt und vom Anwender lediglich ergänzt werden?

Bei DocumentX (kostet) kannst Du bspw. eine Doku erstellen, manuell bearbeiten und dann das Endprodukt generieren lassen. Wenn man diese Werkzeuge entsprechend einsetzt, kann man sicherlich die Projektdateien der Doku in einer Quellccodeverwaltung lagern und die Ausgabe jeweils an einem Ort generieren lassen, aus dem sich ein Intranetwebserver bedient.

Warum ein Treeview mit Technologien? Wieviele Technologien gibt es bei Dir pro Projekt?

Was mich zu der Frage bringt, was soll der Hauptzweck des ganzen sein? Eine projektbezogene Entwicklerdoku oder etwas projektübergreifendes ("ich habe doch mal xy verwendet, in welchem Projekt war das noch und wie habe ich das implementiert")

Du hattest vor einer ganzen Weile mal Screenshots einer Applikation von Dir gezeigt, die die Solution- und Projektdateien von VisualStudio verwendet hat. Bezieht sich "Technologien" auf die Projekttypen von VisualStudio?

Btw: Ein Wiki ist eine sehr flexible Sache und man kann das ganze auch anders einsetzen als es z.B. Wikipedia tut. Allein schon vernünftiges Kategorien-Handling und die Verwendung eigener Infoboxen und ein Minimum an Disziplin bei den Anwendern können Wunder wirken.

[Gateway_man]

Hi,

ich will auf keinen Fall chm Help files. Ich will eine Website die ich auf einem IIS hosten kann. Wie gesagt strukturell soll es so aufgebaut sein wie die msdn.

Gibts sowas zu kaufen?

Xml Kommentare wird von der IDE sowie der Programmiersprache nicht unterstützt.

LG

Gateway

[Pixie]

Die meisten Tools generieren verschiedene Output-Formate, auch HTML.

Die neueren bieten auch verschiedene Stylesheets zur Auswahl, u.a. auch MSDN lookalike.

Wenn XML-Kommentare nicht unterstützt werden, soll dann der gesamte Content selbst erstellt werden?

Dann würde es ein entsprechend angepasstes CMS auch tun.

[flashpixx]

Ich empfehle Doxygen mit XML Export. Das XML kann dann mittels XSLT in ein beliebiges Ausgabeformat transformiert werden.

Ich habe dieses einmal für Markdown gemacht (siehe https://github.com/flashpixx/Storage)

[Gateway_man]

Super, danke euch beiden. Werde mir alles mal in ruhe ansehen und ausprobieren.

LG

Gateway