Willkommen auf myCSharp.de! Anmelden | kostenlos registrieren
 | Suche | FAQ

Hauptmenü
myCSharp.de
» Startseite
» Forum
» Suche
» Regeln
» Wie poste ich richtig?

Mitglieder
» Liste / Suche
» Wer ist online?

Ressourcen
» FAQ
» Artikel
» C#-Snippets
» Jobbörse
» Microsoft Docs

Team
» Kontakt
» Cookies
» Spenden
» Datenschutz
» Impressum

  • »
  • Community
  • |
  • Diskussionsforum
Dokumentation erstellen
Satanlike
myCSharp.de - Member



Dabei seit:
Beiträge: 133

Themenstarter:

Dokumentation erstellen

beantworten | zitieren | melden

Hallo,

ich habe hier ein C#-Projekt, welches auch schon fertig dokumentiert ist. Nun möchte ich daraus eine Dokumentation erstellen, die quasi ein "Buch" aus dem Quellcode generiert. Unter Linux für C heißt das C-Web (falls das jemand kennt). Das Projekt ist für mein Studium und ich habe keine Lust, da noch viel extra mit Word was schreiben zu müssen... Also dass z.B. die Infos aus dem <summary>-Tag die Überschrift für eine Methode sind und der Quelltext der Methode etwas eingerückt und kursiv dargestellt wird. (nur als Beispiel ). Hoffe sowas gibt es, wenn man nach soetwas sucht, findet man fast nur sowas für XML, aber ich brauchr halt etwas anderes...

Mfg
Jan
private Nachricht | Beiträge des Benutzers
herbivore
myCSharp.de - Experte

Avatar #avatar-2627.gif


Dabei seit:
Beiträge: 52329
Herkunft: Berlin

beantworten | zitieren | melden

Hallo Satanlike,

http://ndoc.sourceforge.net/

herbivore
private Nachricht | Beiträge des Benutzers
maxE
myCSharp.de - Member



Dabei seit:
Beiträge: 456
Herkunft: Sachsen

beantworten | zitieren | melden

Ein Problem von ndoc ist allerdings, dass die Entwicklung eingestellt wurde. Sehr schade wie ich finde. Jemand hat versucht das Projekt weiter zu führen:
http://sourceforge.net/projects/ndoc05
Alternativ kannst du auch Doxygen benutzen. Akzeptiert inzwischen auch C# Dokumentationstags (Wenn auch nicht vollständig).
I am Jack's smirking revenge.
I am Jack's raging bile duct.
I am Jack's cold sweat.
I am Jack's complete lack of surprise.
I am Jack's broken heart.
I am Jack's wasted life.
private Nachricht | Beiträge des Benutzers
Satanlike
myCSharp.de - Member



Dabei seit:
Beiträge: 133

Themenstarter:

beantworten | zitieren | melden

Danke für den Link, das "alte" NDOC geht ja leider nicht mit .Net 2.0... hab da zwar diverse HOW-TOs gelesen wie es doch gehn soll, aber funktionieren tut da trotzdem nix. Naja, werde nun mal die Beta testen...

edit: also ndoc funktioniert immer noch nicht richtig, aber mit doxygen bekomm ich einen output, allerdings nicht so, wie ich ihn gern hätte... Letztendlich hätte ich gerne genau eine Datei (z.B. .pdf), die genauso aufgebaut ist wie der Quellcode:

Datei1..
Klasse1
Liste der Variablen (text aus summary-tag)
Methode1 (summary-tag)
Name von Methode1
Quellcode von Methode1
Methode2
Name von Methode2
Quellcode von Methode2
Klasse2
etc...
Datei2...

Weil bei diesen ganzen html dateien blickt keiner mehr durch, nichtmal ich, obwohl ich den Code doch ganz gut kenne
private Nachricht | Beiträge des Benutzers