ClassLibrary: "kein kommentar"

Question

ClassLibrarys sind was schönes! Nur ohne <summary> / kommentar bringt mir das alles GARNICHTS!

Im Quellcode sind alle Kommentare und summarys sichtbar !

Nur nach dem compile ist da nichts mehr von den kommentaren zu sehen!

Auch die Exceptions die sich so ergeben die fallen auch alle untern Tisch.

Ich vermute das meine DLL zu schüchtern ist zu meinen usern. Nur wie kann ich meiner dll diese schüchternheit nehmen?

---

sihst du hier schreibrechtungs fehler habe ich das geschrieben! this.Title = "NERDS RULE!";

Answer 1

Hallo S

mit XML Documentation Comments
http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

http://msdn.microsoft.com/en-us/magazine/dd722812.aspx

kann man sowohl eine Help  (ggf via Sandcastle Tool)
http://sandcastle.codeplex.com/

sowie Intellisense anbieten.

Answer 2

Hallo S.,

• > Nur nach dem compile ist da nichts mehr von den kommentaren zu sehen!

ja, by design.
Normalerweise muss man einfach die Dokumentations-Datei-Erstellung (XML) aktivieren (also mit /doc bzw. "XML-Dokumentationsdatei-Checkbox unter Projekteigenschaften/Erstellen abhaken) und dafür sorgen, dass diese XML-Datei zum Beispiel in dem Ordner ist, in dem die DLL liegt. Die Exceptions sollten dann auch korrekt angezeigt werden:

[Gewusst wie: Generieren einer XML-Dokumentation für ein Projekt]
http://msdn.microsoft.com/de-de/library/x4sa0ak0.aspx

... oder gemäß den Möglichkeiten in Config-Dateien den Suchpfad erweitern, wo diese DLLs und XML-Dateien gesucht werden. Die Dokumenations-Tools wie Sandcastle, Doc-To-Help, NDoc, etc. spielen bei der reinen Intellisense-Anzeige im Code übrigens keine primäre Rolle und sind erstmal für Dein Vorhaben nicht notwendig - sie sind mehr dafür vorgesehen, dass später eine "ansprechende" sinnvolle Doku daraus erstellt wird.

---

ciao Frank

Answer 3

Danke, das mit der XML-Dokumentationsdatei klappt super!

Nur ist noch das problem das wenn ich z.B.

    /// <summary>
    /// Verwaltet strings welche sogar in Codierter form verwaltet werden.
    /// HI
    /// </summary>

in meinen Quellcode meiner Classlybrary schreibe sollte es so im Intelli-sense aussehen

 

Verwaltet strings welche sogar in Codierter form verwaltet werden.
HI

 

Ist nicht der fall!

Es sieht so aus

 

Verwaltet strings welche sogar in Codierter form verwaltet werden. Hi

 

Bedeutet die Zeilensprünge fehlen. Wie mache ich das richtig?

in der XML datei sind die Zeilensprünge enthalten, werden aber wenn ich die XML datei im internetbrowser öffne nicht mit interpretiert

---

C# ist so gut wie meine rechtschreibung schlecht

Answer 4

Hallo S.,

wenn Du den Zeilenumbruch erzwingen musst, benutze zum Beispiel:

  /// <summary> <para>Verwaltet strings welche sogar in codierter Form verwaltet werden.</para>
  /// HI
  /// </summary>

---

ciao Frank

Answer 5

Danke!

Damit währe alles geklärt.

---

C# ist so gut wie meine rechtschreibung schlecht