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: docs/dev-process/coding-guidelines.md
+7-1
Original file line number
Diff line number
Diff line change
@@ -86,9 +86,15 @@ We also run the [.NET code formatter tool](https://github.com/dotnet/codeformatt
86
86
87
87
* Make sure the added/updated comments are meaningful, accurate and easy to understand.
88
88
89
-
* Public members must use [doc comments](https://docs.microsoft.com/dotnet/csharp/programming-guide/xmldoc/).
89
+
### Documentation comments
90
+
91
+
* Create documentation using [XML documentation comments](https://docs.microsoft.com/dotnet/csharp/codedoc) so that Visual Studio and other IDEs can use IntelliSense to show quick information about types or members.
92
+
93
+
* Publicly visible types and their members must be documented.
90
94
Internal and private members may use doc comments but it is not required.
91
95
96
+
* Documentation text should be written using complete sentences ending with full stops.
97
+
92
98
## Performance Considerations
93
99
94
100
PowerShell has a lot of performance sensitive code as well as a lot of inefficient code.
0 commit comments