C# to Require XML Documentation for internal members

Question

Visual Studio has a nice feature to spit out a bunch of compiler warnings if some of the public members are missing XML documentation.

I would love to have the same for internal, or better, any non-private members, but unfortunately so far I wasn't able to find how to configure the level of visibility for which to require XML documentation.

I admit that the same question was asked a long time ago, but the OP didn't get a single answer.

score 2 · Accepted Answer · answered Oct 28 '10 at 09:23

2

You can use StyleCop to require many styling rules for your code. Xml comments is one of those rules.

answered Oct 28 '10 at 09:23

Andrew Bezzub

15,744
7
51
73

You can configure StyleCop to run with VS builds but it requires StyleCop installed on all developer and build machines. – Andrew Bezzub Oct 28 '10 at 10:05

score 0 · Answer 2 · answered Mar 13 '13 at 14:26

0

You can use ReSharper's Agent Smith plugin to prompt you with standard in-line warnings.

answered Mar 13 '13 at 14:26

Anton Georgiev

610
6
14

C# to Require XML Documentation for internal members

2 Answers2