XML-Dokumentation im Implementation-Abschnitt wird nicht erzeugt

[sx2008]

Zitat von ToFaceTeKilla:

Aber es wurde nun mal so beschlossen, dass das gemacht werden soll, also bleibt mir ja nichts anderes übrig.

Ja, das kenne ich nur zu gut.
Aber ein gutes Team kann schlechte Entscheidungen auch wieder korrigieren (es sei denn der Chef stellt sich quer).
Argumentationshilfe hast du ja jetzt.

Es gibt noch einen Grund, weshalb XML-Kommentare im Implementation-Abschnitt ignoriert werden.
Die XML-Kommentare beschreiben z.B. das Interface einer Klassenbibliothek mit grafischen Effekten.
Zielgruppe sind Programmierer, die sich schnell einen Überblick verschaffen wollen.
WIE etwas implementiert interessiert hier nicht und gehört nicht in diese Doku.

Das heisst also, selbst wenn der Interface-Abschnitt mit XML-Doku gepflastert ist, bleibt alles nach Implementation davon frei und man benützt ganz normale Kommentare in diesem Bereich.

Zusätzlich sollten grössere Projekte aber noch ein eigenes Text- oder Word-Dokument namens "Programmer's Guide" haben, in dem man technische Aspekte und Entscheidungen festhält.
Dieses Dokument wäre der ideale Einstiegspunkt für neue Programmierer die ins Team aufgenommen werden.
Der Programmer's Guide wird von jedem Teammitglied gepflegt und wie Sourcecode in die Versionsverwaltung eingefügt.