Laden...

Mini-Tutorial: Dokumentationen mit ndoc erstellen

Erstellt von entelechie vor 20 Jahren Letzter Beitrag vor 20 Jahren 3.172 Views
E
entelechie Themenstarter:in
63 Beiträge seit 2003
vor 20 Jahren
Mini-Tutorial: Dokumentationen mit ndoc erstellen

hm. ist eigentlich kein richtiges tutorial...

es gibt ein prima tool mit dem sich dokumentationen
im msdn stil erstellen lassen:
das ganze heisst ndoc.

was ihr tun muesst:
1)
also kommentare muesst ihr die c# eigenen (///) verwenden.
dazu gehbt ihr direkt ueber einer klassen-/methoden- oder attributdeklaration
einen 3-fachen '/' ein.


using System;

namespace ConsoleApplication1
{
	/// <summary>
	/// Das kommt in die Doku.
	/// </summary>
	class Class1
	{
		/// <summary>
		/// Das auch :).
		/// </summary>
		[STAThread]
		static void Main(string[] args)
		{
			//
			// TODO: Fügen Sie hier Code hinzu, um die Anwendung zu starten
			//
		}
	}
}

jetzt muesst ihr nur noch eine xml datei erstellen lassen.
dazu gebt ihr den namen der zu erstellenden xml datei in den projekteigenschaften an:
projekteigenschaften -> konfigurationseigenschaften -> erstellen -> xml dokomentationsdatei -> (einen namen: z.b. test.xml).

standardmaessig ist das feld leer, d.h. es wird keine xml-doku erzeugt.

3)
das projekt erstellen. dabei wird nun automatisch eine xml datei erzeugt.

4)
ndoc starten -> add
nun die xml datei und die dll des projektes angeben.

5)
feritg

2.217 Beiträge seit 2003
vor 20 Jahren

interessant interessant werde mir das mal ansehen

Viele Grüße
Alexander

C
980 Beiträge seit 2003
vor 20 Jahren

Lohnt sich jedenfalls! Ich setze NDoc schon seit längerem für mehrere Projekte ein ...

Neben dem klassischen CHM generiert es bei Bedarf gleich noch ein entsprechendes Frameset (vgl. MSDN Online), dass sieht dann z.b. so aus: http://dev.cdrnet.net/projects/neuro/msdn/