Visual studio 2008 - XML multiline comments in C# - what am I doing wrong. Zeilenumbruch in XML Methoden-Kommentar. Hallo Thorsten, > das erscheint ... scheinen ist "nicht wissen" - aber no prob. Dass <para/> in den professionellen Tools (u.a. Sandcastle/SHFB und natürlich eben auch VS Intellisense) funktioniert, liegt eher an der XML-Grundlagen (Spezifikation), als an der Dokumentation der XML-Tags.
Deine Tags werden ja in eine XML-Datei generiert und unterliegen der XML Spezifikation. Ein (professionelles) nachverarbeitendes Tool kann gar nicht anders, als ein <para/> gleichwertig mit <para></para> zu sehen. <pre> Zeile1 Zeile2 Zeile3 </pre>, ... würde alles korrekt sein, funktioniert aber nicht für VS in der Intellisense. Da sind schon die <para> ... Ciao Frank. Wichtige Visual-Studio-2008-Tastenkombinationen. 04_Sandcastle.pdf (application/pdf-Objekt) NDoc Online. C# XML-Kommentare — Dokumentation von selbst.
Geschrieben von: Bernhard Spuida Kategorie: Dokumentation 66671 Zugriffe. 132 Bewertungen, Durchschnitt 2.24 "Kommentare brauche ich nicht, ist doch eh klar was passiert" — Zwei Monate später: "Häh??? ". Käufer der Komponente: "Und wie bitte soll ich das aufrufen? " — wenn wir mit unseren Softwarekomponenten erfolgreich sein wollen, müssen sie leicht verwendbar sein.
Wenn wir in einem Team Software entwickeln, müssen unsere Kollegen mit unserem Code ihre eigenen Aufgaben erledigen können. Wir haben in beiden Fällen zwei Möglichkeiten: Wir sind immer für Erklärungen verfügbar Unser Code ist sauber dokumentiert Möglichkeit 2 ist doch entschieden attraktiver, oder nicht? Für die Beispiele in diesem Artikel wird das .NET Framework SDK, sowie wahlweise Visual Studio.net oder SharpDevelop und/oder NDoc benötigt.
Warum kommentieren? Nach einer erschreckend kurzen Zeit kennt man seinen eigenen Code ohne Dokumentation nicht mehr. Die Antwort ist in allen Fällen nein. Was kommentieren? Wie kommentieren?