1

I'm in the process of generating documentaion for my API using sandcastle, however there are many undocumented sources in the assembly that that i'm generating the chm for, is there a way to get a list of the undocumented types (or those that have missing documetation for their members)?

Improve this question

1 Answer 1

Reset to default
2

I think that there is an FxCop (aka code analysis) warning that can be enabled when xml comments are missing or incorrect. This is done from the compilation settings for the project.

The doxygen tool can generate warnings and it reads the standard C# xml comments. It is documented in the doxygen comment file how to enable warnings on missing docs.

Improve this answer
Sign up to request clarification or add additional context in comments.

1 Comment

It is possible to extract (using excel etc..) some sort of a report from the available warnings, even within VisualStudio itself, however i still feel that there ought to be a more professional tool for this, perhaps as an add in to other code quality enhancers/plugins such resharper or ndepend.

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.