rule_id | rule_category | title | severity |
---|---|---|---|
2305 |
commenting |
Document all `public`, `protected` and `internal` types and members |
2 |
Documenting your code allows Visual Studio, Visual Studio Code or Jetbrains Rider to pop-up the documentation when your class is used somewhere else. Furthermore, by properly documenting your classes, tools can generate professionally looking class documentation.