You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _rules/2305.md
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,4 +4,10 @@ rule_category: commenting
4
4
title: Document all `public`, `protected` and `internal` types and members
5
5
severity: 2
6
6
---
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