Laden...

API Dokumentation erstellen

Erstellt von pearsh vor 10 Jahren Letzter Beitrag vor 10 Jahren 2.738 Views
pearsh Themenstarter:in
209 Beiträge seit 2007
vor 10 Jahren
API Dokumentation erstellen

Hallo!

Ich bin auf der Suche nach einer guten Möglichkeit, meine API für unsere Supporter im Büro zu dokumentieren. Meine Applikation ist in C# geschrieben und öffnet nach Außen eine große Vielfalt an customizing Optionen. Eines dieser Optionen ist es, das Produkt mit Hilfe von IronPython anzupassen.

Jetzt suche ich nach einer Möglichkeit, wie ich von Hand (Keine automatisch generierte Dokumentation!) die API dokumentieren kann.

Ideal wäre ein "Tool", welches mir die Dokumentation im Anschluss so darstellt: MDN-Dokumentation

Kennt sich jemand mit sowas aus und hat eventuell ein Produkt was er empfehlen kann?

MfG

2.298 Beiträge seit 2010
vor 10 Jahren

Gibt es einen Grund, warum die Dokumentation nicht automatisch erstellt werden darf?
Gerade bei einer API halte ich es für sehr aufwendig, jeden Namespace und jede Klasse, sowie Methode per Hand zu beschreiben.

Wissen ist nicht alles. Man muss es auch anwenden können.

PS Fritz!Box API - TR-064 Schnittstelle | PS EventLogManager |

pearsh Themenstarter:in
209 Beiträge seit 2007
vor 10 Jahren

Moin,

weil die Namen in dem IronPython Code (DLR) nicht immer die gleichen sind wie im C# Code. Einige Klasse registriere ich absichtlich mit einem anderen Namen.

Des weiteren will ich nur ein paar Methoden und Klassen dokumentieren.

148 Beiträge seit 2013
vor 10 Jahren

Prinzipiell musst du ja eh deine Methoden, Typen usw. per Hand dokumentieren (Inline-Dokumentation). Die Generatoren nehmen dir lediglich die Erstellung der Ausgabe ab. Sonst müsstest du ja selber alle HTML Seiten zum Beispiel anlegen und mit Inhalt füllen. Halte ich für etwas aufwendig...

Des weiteren will ich nur ein paar Methoden und Klassen dokumentieren.

Du solltest eigentlich bei jedem ordentlichen Tool auswählen können, welche Methoden und Typen in der Doku beinhaltet sein sollen.

pearsh Themenstarter:in
209 Beiträge seit 2007
vor 10 Jahren

Oder ich baue mir meine eigene kleine Website, die eine eigene Syntax zum schreiben der Dokumentation hat.


<Tags></Tags>

<ProductVersion></ProductVersion>

<Status Value="Obsolete" />
<Status Value="Removed" />

<Title></Title>
<Text></Text>

<Code Language="IronPython"></Code>
<Code Language="SQL"></Code>
<Code Language="C#"></Code>

<BulletList>
    <Bullet></Bullet>
    <Bullet></Bullet>
    <Bullet></Bullet>
</BulletList>

MfG