Is there a rule to require method documentation for C#?

SonarQube
,
1

Hello,

I’d like to require method documentation as a rule but I can’t find the proper rule. Can I set a valid rule to require documentation, or will I need to create a custom rule?

I appreciate any help.

4

Hello @Ruvim_P,

We do not have a rule for this in the C# Analyzer.

In fact, there is already a built-in warning in .NET: CS1591.
One of the easiest ways to activate it is to set the GenerateDocumentationFile to true in your project file.
Check the documentation for more information.

I hope this fits your needs!

Have a great day!