Warnings

[DrJeykyll]

Hi,

ich habe seit einiger Zeit meine Kommentare zu dem C#Code(VisualStudio03) in eine xml-Datei gehauen.
Das ist auch alles schön und gut, aber ich habe ein Problem mit der Ausgabe. Es gibt jetzt tausende Warnings wegen jedem Klein, z.B weil der Parameter nicht angegeben ist oder das include-Tag nicht vorhanden ist. In bestimmten Namespaces brauch ich das allerdings nicht. Gibt es da irgendeine Lösung?

Gruß,
Julia

 

[Norbert Eder]

Grundsätzlich sollten, wenn Parameter vorhanden sind, diese auch beschrieben werden. Sonst bringt die ganze Code-Doku nichts. Und beim IntelliSense (dafür wird die XML-Ausgabe ja im Endeffekt benötigt) ist das schon sehr hilfreich.

 

[DrJeykyll]

Ja sicher ist das so,das find ich ja auch alles gut. Mein Code ist nur so lange, dass ich mich dazu entschlossen habe eben nicht alles zu kommentieren. Wenn ich aber jetzt jeden einzelnen Fehler durchgehe, sitze ich da ne Woche da. Aber wahrscheinlich habe ich keine andere Wahl.

 

[Nico Graichen]

Hi

Die Warning kommen nur für Definitionen, die als Public deklariert sind. Vielleicht kannst du auch dadurch die Liste kürzen, in dem du schaust, ob die entsprechenden Methoden etc auch wirklich public sein müssen.

Aber wie Norbert schon gesagt hat, steht dir die Hilfe dann nicht mehr in der Intellisense zur Verfügung, wenn du sie nicht beschreibst