views:

58

answers:

2

I'm starting a new project; trying to be more strict than previous ones. I've set warnings as errors in the build I've added FxCop to PostBuild. The one last thing on my list os require people to add inline docs for all classes/non-private methods/properties.

Is there a custom FxCop rule or another exe I can run in the post build to check? I've having a hard time finding something, which is surprising.

+1  A: 

Bingo: http://www.ookii.org/software/xmlcommentchecker/

claco
No the next trick is to figure out how to turn its warnings into a build breaking failure.
claco
In my case, recompile the source to output error in the console instead of warnings. Then the build fails.
claco
A: 

The VB.NET compiler doesn't help much in this regard as I've only ever seen it issue a warning for something like <param name="foo">...</param> when you don't have a parameter called "foo" in the function, but nothing at all for missing tags which is annoying.

The method I use on my projects is to use the build log from Sandcastle and grep it for the warnings it spits out since they're faily easy to match (they all begin with something like "Warn: ShowMissingComponent:" and it will issue a warnings for all sorts of missing tags in your code.

lee-m