Michiel van Otegem, IT Composer

Tuesday, June 28, 2005

Automatisch commentaar bij code

Ik ken geen enkele ontwikkelaar die het leuk vindt om z'n code van commentaar te voorzien. Zo krijg ik regelmatig hele lappen code te zien waar bijna geen commentaar in staat. Nu vind ik het nog tot daar aan toe als de code in een method/property niet van commentaar voorzien is, maar c# code zonder XML comments bij dit soort elementen werken bij mij als een rode lap op een stier. Geef op z'n minst een omschrijving van wat de methode doet! Dat je niet documenteert welke exceptions eruit kunnen volgen e.d. dat snap ik... dat is pas echt een kl*t* werk. Maar... HELP IS ON THE WAY! Je kunt een hoop commentaar automatisch laten verzorgen met macro's, zoals uitgelegd in dit artikel. Wat overigens ook gaat helpen is de class designer in VS2005, waar het wel heel makkelijk mee is om commentaar in te voegen bij methodes, properties, parameters, enz.

0 Comments:

Post a Comment

<< Home