Vs2003 Vs2005

Hallo

bei VS2003 gab es die Möglichkeit unter Extras den Befehl Erstellen
von Kommentarwebseiten"

gibt es dies nicht mehr in VS2005? ich finde das nirgends, in der hilfe
zeit es aber an, wie man die kommentare schreiben kann, aber nicht wie
ich es erstellen muss, damit ich nachher die webseite habe.

kann mir da jemand weiterhelfen?

danke

Diese Funktion gibt es im Visual Studio 2005 nicht mehr. Anstatt dessen kannst du NDoc oder DoxyGen verwenden.

gibt es dies wirklich nicht mehr?

wo kriege ich diese tools her?

greetz

Hallo torkel!

Ich verwende schon je her NDoc und bin deshalb begeistert, weil es vergessene XML-Kommentare ROT markiert und man dann nochmal nachbessern kann.

Außerdem gibt es verschiedene Ausgabeformate, wie HTML-MSDN-Style, WinHelp-Format ...

Dieses Programm gibt es unter Sourceforge -> Suchkriterium NDoc und Du findest es recht schnell.

Was ich auch gut finde, ist die Tatsache, dass es sich NICHT in VS mitreinpflanzt, sondern von extern die Dokumente erstellt (Halte ich für ein Vorteil).

Zu anderen Dokumentenersteller kann ich nix sagen...

Viel Spaß damit,

Norman-Timo

hallo norman_timo

wie kann ich denn jetzt so ein HTML file mit Ndoc erstellen, wenn es nicht in vs integriert ist? hab es mal installiert, blick aber net durch und in der hilfe stehen nur die parameter, die man für den code verwenden muss..

kannst du mir evt. schnell sagen, wie ich ein projekt importieren kann?

greetz

torkel

Hallo torkel!

Zunächst folgendes:
Im VS die Option Properties->Configuration Properties->XML-Documentation file eintragen, bestenfalls genauso wie Dein projekt heißt, nur .xml am Ende!

In NDoc gibt es ein Button "Add" direkt neben dem großen weißen leeren Feld, dieser muss gedrückt werden und beliebige Assemblies hinzugefügt werden (dll, exe oder ähnliches).

Dann kannst Du noch die Option im unteren Feld auswählen, wie welcher Style rauskommen soll, und ob private members mit dokumentiert werden sollen ...

Dann klickst Du auf Documentation->Built. Et voilá dann sollte die Dokumentation erstellt worden sein.

Vorsicht! Bei NDoc ist ein Projekt KEIN VS-Projekt!!! Du kannst hier nur alle schon mal gemachten Einstellungen in einem NDoc-Projekt speichern, und falls Du änderungen am Sourcecode gemacht hast, ganz einfach NDoc-Projekt laden und neue Doku erstellen (überschreiben).

Also nicht verwechseln!

Hoffe jetzt ist alles klar?

Ciao
Norman-Timo

Du erstellst ganz normal deine Assembly und die XML-Doku, lädst diese in NDoc. Dann hier und da noch Einstellungen wie gewünscht ändern und die Dokumentation erzeugen lassen. Fertig.

MfG VizOne

Ich war schneller VizOne gg

Ciao
Norman-Timo

🙂

Ich kann auch nur Doc-O-Matic empfehlen. Ist zwar kommerziell, hat aber nette Funktionen, die weit über die Freeware-Tools hinausgehen. Zudem sprachübergreifend.

Baut z.B. automatisch kleine Vererbungsdiagramme, unterstützt nicht nur HTML sondern auch .doc und pdf als Ausgabeformat und bietet auch eine Alternative zu den .NET-Xml-Doc-Tags. So kann die Doku zu einem Parameter direkt innerhalb der Deklaration stattfinden und nicht in einem seperaten XML-Block wie in .NET ja Standard.

Vorteil: Lösche ich den Parameter, lösche ich zugleich die Doku. So wird zumindest teilweise das Problem vermieden, dass Code und Doku nach Änderungen nicht mehr zueinander passen.

Als größten Vorteil empfinde ich die Tatsache, dass es auch gedruckte Versionen der Hilfe generiert, die sich ja logischweise von Hypertext-Varianten unterscheiden muss.

Hallo Svenson

ich hab es mal mit dem Doc-O-Matic versucht.. trail version...

gibt es da irgenwo ne deutsch doku? ich schnall das net.

bei mir kommt immer ein compiler error

gibt es evt. noch eine anderes Tool? das Ndoc läuft nur mit .net 1.. habe aber .net 2

greetz

Du hast Recht, mit .NET 2 funktioniert es nocht nicht (so richtig). Ich habe es zumindest so weit hingekriegt, dass es läuft und generics zumindest ohne Fehlermeldung verarbeitet (aber nicht mit der richtigen Ausgabe).

Folgende Schritte sind nötig:

1. config File für NDocGui.exe

<configuration>
  <startup>
    <supportedRuntime version="v2.0.50215"/>
  </startup>
</configuration>

Die folgenden beiden Methoden in ReflectionEngine.cs

private string GetTypeNamespaceName(Type type) {
	// HACK - fix for generics
	if ( type.FullName == null ) {
		return "typeparam:" + type.Name;
	}
	return type.FullName.Replace( '+', '.' );
}

private string GetTypeName(Type type) {
	// HACK - fix for generics
	if ( type.FullName == null ) {
		return "typeparam:" + type.Name;
	}
	return type.FullName.Replace( '+', '.' ).Replace( "&", null ).Replace( '+', '#' );
}

3. In MsdnDocumenter.cs:

// hinzüfgen:
private string FixFileName(string fileName) {
	return fileName.Replace("<", "_").Replace(">", "_");
}

// In jeder Methode GetFilenameFor... dies hier vor dem return fileName hinzufügen:
fileName = FixFileName(fileName);

// z.B.
private string GetFilenameForNamespace(string namespaceName)
{
	string fileName = namespaceName + ".html";
	// folgende Zeile ist hinzugefügt
	fileName = FixFileName(fileName);
	return fileName;
}

Müsste eigentlich funktionieren. Wer das nicht selbst machen möchte, kann sich die "gepatchen" Dateien auch bei mir runterladen: http://gentlestorm.de/stuff/NDoc 1.3 dotnet 2 patch.zip Alles ohne Gewähr. Bei mir läuft es soweit, dass ich eine Dokumentation erzeugen kann. Wie gesagt, generics werden noch nicht richtig behandelt (vor allem generische Methoden), aber für den Moment reicht es.

MfG VizOne

welche version hast du genau installiert?

1.3.1, den aktuellen Stand habe ich mir noch nicht angeschaut.

MfG VizOne

Original von torkel
Hallo Svenson

ich hab es mal mit dem Doc-O-Matic versucht.. trail version...
gibt es da irgenwo ne deutsch doku? ich schnall das net.
bei mir kommt immer ein compiler error

VS2005 wird erst mit der allerneuesten Version unterstützt. Doku ist wohl nur in englisch.

das heisst version 4.5?

Ja.