Doku und C#

[Christian Zink]

Hi Leutz!

Mit .net soll ja auch die Programm Doku viel ebsser werden. Aber so richtig funzen tuts net.

<summary> geht supär.

Aber mit <value>, <exception>, <param>, <remarks> hab ich so meine Probleme. Lass ich die Online Doku erstellen, so finde ich nirgends die Mommentare die ich mit solchen Tags eingeschlossen habe.
Hat da wär ne Idee, wies besser geht?

Bsp:<br>

public class irgendwas<br>
{<br>
....<br>
/// <value><br>
/// Min / Max des Wertebereichs<br>
/// </value><br>
<br>
private int WTinyIntMIN;<br>
<br>
....<br>
}<br>

Chris

[dicabor]

hi Chris

ich bin selber sehr erstaunt das es mit value nicht funzt also die anderen Tags laufen ohne probleme<BR>
<PRE> /// &lt;summary&gt;<BR>
/// &lt;list&gt;&lt;description&gt;<BR>
Das ist ein Property&lt;/description&gt;&lt;/list&gt;&lt;/summary&gt;<BR>
private string Name1<RB>
{<RB>
get<BR>
{return name;}<BR>
}<BR>
</PRE> nur der value tag nicht. ich selber arbeite ja nur mit NDoc. ist für meinen geschmack die elgantere art code zu dokumentieren, weil du am ende ein .chm-file erhältst. wenn du dich mit NDoc beschäftigen magst hier zwei links:

http://aspheute.com/artikel/20020730.htm

http://inv192s/MyWeb/CSharpDocu.htm

bey der Dic

[Christian Zink]

Lösung ... habs selbst rausbekommen.

1. Man schreibe seine Methode, mit Argumenten, Rückgabewerten und was sonst noch.<br>
2. Erst wenn Methodenkopf und die Klammern { stehen, gehe man von unten (von Methodenrumpf nach oben. keine Freizeile lassen und dann 3 /// machen ... und siehe da - es geht!
<p>

Ich habe die Doku immer mit Hand schreiben wollen, deswegen gings net. Und schon kann man sich unter EXTRAS die Webseiten generien lassen. Spitze.

Chri