Skip to content

Commit f1fc4c3

Browse files
authored
Update AV2305: Document all public, protected and internal types and members (#381)
1 parent e4cc35e commit f1fc4c3

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

_rules/2305.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,10 @@ rule_category: commenting
44
title: Document all `public`, `protected` and `internal` types and members
55
severity: 2
66
---
7-
Documenting your code allows Visual Studio, [Visual Studio Code](https://code.visualstudio.com/) or [Jetbrains Rider](https://www.jetbrains.com/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.
7+
Good functional documentation allows Visual Studio, [Visual Studio Code](https://code.visualstudio.com/) or [Jetbrains Rider](https://www.jetbrains.com/rider/) to display the documentation when your class is used somewhere else. Furthermore, by properly documenting your classes, tools can generate professionally looking class documentation.
8+
9+
See also [{{ site.default_rule_prefix }}2306](/documentation-guidelines#{{ site.default_rule_prefix }}2306)
10+
11+
**Exception:** Sometimes the purpose is so obvious that the documentation would become repetitive. Don't do that.
12+
13+
**Note:** You don't need to use `/// <inheritdoc/>` on overriding or implementing members. Visual Studio and Rider will automatically inherit documentation from the base type or interface.

0 commit comments

Comments
 (0)