Möchtest du den Code für Dich selbst oder für andere dir möglicherweise noch unbekannte Programmierer bereitstellen?
Wenn der Sourcecode als Open Source veröffentlicht werden soll, oder wenn er an andere Kunden verkauft werden soll, dann ist die
XML-Dokumentation im Prinzip eine gute Sache.
Wenn der Sourcecode aber nur von Dir und vielleicht noch deinen Kollegen benutzt/bearbeitet wird, dann ist die
XML-Doku eher sogar störend.
Fängt man mit der
XML-Doku an, dann ist man praktisch gezwungen es komplett durchzuziehen.
Das Verhältnis zwischen Sourcecode und Kommentaren erreicht dann 50:50.
Das ist Erstens eine grosse Zeitverschwendung wenn man die Doku nicht wirklich braucht und Zweitens
verhindert es Fortschritt und Umstrukturierungen im Code.
Wer würde Funktions-, Klassen- und Parameternamen einfach so umbenennen, wenn er ständig die
XML-Kommentare nacharbeiten muss?
Wer würde sich trauen eine ganze
Unit wegzuwerfen (weil z.B. der Ansatz schlecht war) und alles nochmal neu programmieren wenn er die ganzen schönen Kommentare verlieren wird?
Kommentare altern übrigens schneller als der Sourcecode; bzw. der Sourcecode verändert sich und die Kommentare werden vergessen.
Was ist schlimmer: kein Kommentar oder überall falsche, veraltete Kommentare?
XML-Kommentare haben also auch einige Nachteile.
Nur wenn man den Sourcecode an eine breite Leserschaft verbreitet, machen
XML-Kommentare einen Sinn (oder für eine Diplomarbeit) ansonsten lieber Finger weg von der Zeitverschwendung.