>In VFP, I do exactly what Craig doesn't like but only in general sections, not for each code block:
>
>
>*--TCHolzer 08/19/2009 BEGIN Issue # 12345 Fix this or that
>*!* original code commented out
>new code here
>...
>*--TCHolzer 08/19/2009 END Issue # 12345 Fix this or that
>
>or general:
>
>*--Explain what the purpose of this section is
>
>etc...
>
>
>however, it is more functional, not specific to what each code block does, because that should be evident to a programmer who knows VFP
>
>in dotnet, we use xml comments for functional sections as well so the developer who comes along later understands the 'purpose' of the code. We don't add specific comments for every single thing because any developer who understands that language should get that immediately.
>
>
Hi Tracy,
The XML comments you apply right before the function/class name, correct? What type of comments do you usually use in the code itself?
If it's not broken, fix it until it is.
My Blog