0
227
ViewsDisable StyleCop's SA1600 rule for internal interfaces
StyleCop.Analyzers: 1.1.118
My stylecop.json:
{
"$schema":
"https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json",
"settings": {
"documentationRules": {
"companyName": "ShapeCrawler",
"documentInternalElements": false
}
}
}
Sample:
Is it possible to disable "SA1600: Elements should be documented" rule for internal interfaces?
·
Santiago Trujillo
1 answers
Answer question0
By definition, internal interfaces are visible to all types within the assembly, and any assemblies that have a "friend" relationship with it via the InternalsVisibleTo attribute. It's generally a good idea to document public members of internal types (including interfaces) unless you have a truly compelling reason not to; at the very least, you'll benefit from IntelliSense documentation at the point of call.
Having said that, if you're determined not to document them, wrap the type in the following:
#pragma warning disable 1591
[Your code here]
#pragma warning enable 1591
·
Santiago Trujillo
Report
Answer question