[C#] Code Dokumentation: Existiert ähnliches wie Javadoc?

[kalleberlin]

Hallo

die Frage im Titel beschreibt es ja schon ganz gut .

Gibt es sowas auch für C#? Wenn es geht dann bitte kostenlos.

//edit:

Angemerkt sei noch das ich als IDE Visual Studio C# 2005 Express Edition benutze.

 

[krizzelfix]

SDK
Gibt es auch als Install version. Die wesentlich übersichtlicher ist.

Grüße

tewes

 

[kalleberlin]

Mhh versteh dein Link nicht so richtig ?!?

Eine IDE habe ich breits, ich wollte nur Fragen ob es ein Plugin bzw. eine versteckte Einstellung gibt um eben so etwas ähnliches wie JavaDoc im Visual Studio zu haben.


Mal ein Beispiel wie ich es aus Java kenne (Eclipse IDE):

/*
*
*Mein Dev-Kommentar
*
*/
myFuntion()

Jetzt bin ich in irgendeiner beliebigen anderen Klasse, oder auch in der selben. Und wenn ich nun die "myFunction()" Funktion aufrufe, mit der Maus drüberfahre, dann seh ich das Dev-Kommentar.

Und genau soetwas suche ich eben für die C# IDE .


Wenn ich nun was in deinem Link übersehen haben sollte, dann sry

 

[gac.addy]

Es gibt nDoc http://ndoc.sourceforge.net/
Hab damit noch nie gearbeitet, sollte aber so ähnlich sein wie javadoc

 

[TheCadillacMan]

Das geht sogar mit Standard-C#!

/// <summary>
/// Beschreibung für die Klasse...
/// </summary>
public class Test
{}

Wenn du einfach vor der ersten Zeile einer Methode, Klasse, etc. drei Schrägstriche machst, brauchst du nur noch die Beschreibung zwischen den "summary" Tags eingeben. Die ergänzt die IDE automatisch.

 

[dcdead]

Wenn du eine externe Doku erstellen willst, nimm am beste doxygen (http://www.stack.nl/~dimitri/doxygen/). Das ist ein sehr mächtiges Dokumentationstool, das bspw. sogar automatisch Kollaborations-UML-Diagramme erstellt. Die Beschreibung der Klassen kannst du damit in gewohnter Javadoc-Schreibweise machen.

 

[MagicAndre1981]

Nimm die XML tags, lass dir die die XML-Doku-Datei erstellen und erstelle die Hilfe mit Sandcastle

 

[kalleberlin]

Danke für eure Hilfe, werd das mal testen

//edit:

Das mit dem <summary> ist genau das wonach ich gesucht habt

Dankö