Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Force xml comment for all members

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?

like image 523
tanascius Avatar asked Mar 01 '23 21:03

tanascius


2 Answers

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)

like image 84
abhilash Avatar answered Mar 12 '23 05:03

abhilash


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

like image 24
user7116 Avatar answered Mar 12 '23 05:03

user7116