views:

471

answers:

3

For public members I get a warning "missing XML comment for publicly visible type or member ...". That is great, but not enough. I would like to enable this warning for all (or at least internal and protected) members.

Is there a way to get a warning or information about missing xml comments? Are there any tools at runtime (like Resharper) with that feature?

+3  A: 

StyleCop (aka MS SourceAnalysis) can do this for you. Here is the team's blog where you can read more about it.

sixlettervariables
+1  A: 

Check out StyleCop. Its a Microsoft tool that can be integrated into your build and will generate warnings or errors if it's style rules are not followed.

It has a rule: "SA1600: ElementsMustBeDocumented" that would appear to meet your requirements.

d4nt
+2  A: 

If you are using ReSharper use Agent Smith plugin for ReSharper. It's open source so feel free to see what goo they have in there.

Agent Smith HomePage

Agent Smith source code on Google Code

EDIT: Agent Smith does xml comments validation at code editor runtime(for the lack of the better word)

AB Kolan