Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
In my project almost all classes are internal (instead of public).
Now I would like to document everything (the classes and their public members). Unfortunately, the compiler warning for missing XML comments seems to include only public classes and their members.
Is there any way to get such a compiler warning for internal classes?
(Using Visual Studio 2010 Ultimate, C# 4.0)
You can check out StyleCop by Microsoft (hosted on CodePlex).
It is a very nice rule-based tool that integrates into Visual Studio and scans your solution for any styling issues.
One section of its rules is called “Documentation”, and refers to all sorts of code styling related to documenting the code.
See rules starting with SA1600