Wenn Projekte eine gewisse Größe erreichen oder von anderen Entwicklern genutzt werden sollen, ist es doch immer hilfreich zu sehen was eine Methode, eine Klasse, eine Struktur oder Ähnliches zu einem bestimmten Zeitpunkt genau macht. Aber wie stellt man dies am Besten an? Der erste Schritt hierhin sind sicherlich gut durchdachte „Coding Styles“ an denen sich die Entwickler halten sollten, um so einheitlichen Code zu erschaffen. Aber es gibt da noch einen sehr effektiven Weg den Quellcode mehr als gut zu dokumentieren, die sogenannten Summary-Kommentare. Diese bieten gegenüber normalen Kommentaren zwei Vorteile: 1. Sie sind durch die Visual Studio Intellisense zu sehen. 2. Mithilfe dieser Kommentare und einem zusätzlichen Tool kann eine „Compiled HTML“-Datei (kurz: CHM) erzeugt werden.

Aufgebaut sind diese Kommentare wie normales XML. Hierbei gibt es eine Reihe vordefinierter Tags, es können aber auch eigene genutzt werden. Für den Fall, dass der „Sandcastle Help File Builder“ (siehe: http://www.codeproject.com/Articles/15176/Sandcastle-Help-File-Builder) genutzt wird, um diese Dokumentationsdateien zu erzeugen, können auch andere Quelltexte wie Examples und UnitTests über diese Summary-Kommentare verlinkt werden. Angelegt werden Summary-Kommentare über Methoden, Funktionen, Eigenschaften, Events, Delegates, Klassen, Strukturen sowie Enumerationen. Aber wie sieht so ein Kommentar aus?  Weiterlesen →