Enforcing and checking XML documentation?
I'm working on a C# project in Rider and want to document my entire codebase with XML documentation.
In order to make sure this is done consistantly I want to be able to make sure every method and property is documented. and the method's arguments and return types match that of the actual function.
This seems a fairly standard code quality check so I'd expect it to be possible but I can't find any way to do it, am I missing something?
Posted Dec 3, 2023, 1:31 PM UTC
12
You're looking for CS1591
Make sure the project has a DocumentationFile specified.
Also, some additional analyzers you can use: https://github.com/DotNetAnalyzers/DocumentationAnalyzers
Thanks, I'll have a good look at that later on and hopefully get it all working.