Locating missing documentation

Jun 9, 2012 at 2:11 PM

Further to the post at http://social.msdn.microsoft.com/Forums/en-US/devdocs/thread/9bbad4cc-e229-49da-a6f7-3cdf470ac53a/ where Eric Woodruff stated "The simplest solution is to just suppress the warning by entering it's number (1591 for C#) in the Suppress Warnings field on the Build tab of the project properties.  You can always remove it if you need to find missing comments in your actual code at a later date when you feel like wading through all the extra irrelevant messages produced by the tool-generated code.

If you're using Sandcastle to produce a help file and/or Intellisense file for your assembly, you can use the ShowMissingComponent available at the Sandcastle Help File Builder project (standalone or built into SHFB) to find missing comments in the documented API.  That would give you less to look at since you can filter out elements that you don't want documented and the warnings can be found in the build log file or just by searching the resulting help file for the keyword "missing" since it adds notes to the members to note the missing comments."

First of all thank you for the 1591 suppression tip. There is another way of locating the missing documentation in C# by using StyleCop (and if you have Resharper, then the feedback is immediate).

Also I must thank you and your team for the excellent sandcastle tool.