8000 Add documentation comments section to coding guidelines (#14316) · rkeithhill/PowerShell@ccb5b61 · GitHub
[go: up one dir, main page]

Skip to content

Commit ccb5b61

Browse files
xtqqczzerkeithhill
authored andcommitted
Add documentation comments section to coding guidelines (PowerShell#14316)
1 parent ca4b032 commit ccb5b61

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

.spelling

+1
Original file line numberDiff line numberDiff line change
@@ -383,6 +383,7 @@ includeusername
383383
informationrecord
384384
initializers
385385
install-packageprovider
386+
IntelliSense
386387
interactivetesting
387388
interop
388389
interoperation

docs/dev-process/coding-guidelines.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,15 @@ We also run the [.NET code formatter tool](https://github.com/dotnet/codeformatt
8686

8787
* Make sure the added/updated comments are meaningful, accurate and easy to understand.
8888

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.
9094
Internal and private members may use doc comments but it is not required.
9195

96+
* Documentation text should be written using complete sentences ending with full stops.
97+
9298
## Performance Considerations
9399

94100
PowerShell has a lot of performance sensitive code as well as a lot of inefficient code.

0 commit comments

Comments
 (0)
0