From 1b952a0cd5c31b22c834efc7281979bd733c8873 Mon Sep 17 00:00:00 2001
From: xtqqczze <45661989+xtqqczze@users.noreply.github.com>
Date: Tue, 20 Apr 2021 14:15:54 +0100
Subject: [PATCH] Add documentation comments section to coding guidelines
 (#14316)

---
 .spelling                             | 1 +
 docs/dev-process/coding-guidelines.md | 8 +++++++-
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/.spelling b/.spelling
index 656a4e6570..cd6170b1a3 100644
--- a/.spelling
+++ b/.spelling
@@ -383,6 +383,7 @@ includeusername
 informationrecord
 initializers
 install-packageprovider
+IntelliSense
 interactivetesting
 interop
 interoperation
diff --git a/docs/dev-process/coding-guidelines.md b/docs/dev-process/coding-guidelines.md
index 389981c3f7..9bf46aee02 100644
--- a/docs/dev-process/coding-guidelines.md
+++ b/docs/dev-process/coding-guidelines.md
@@ -86,9 +86,15 @@ We also run the [.NET code formatter tool](https://github.com/dotnet/codeformatt
 
 * Make sure the added/updated comments are meaningful, accurate and easy to understand.
 
-* Public members must use [doc comments](https://docs.microsoft.com/dotnet/csharp/programming-guide/xmldoc/).
+### Documentation comments
+
+* 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.
+
+* Publicly visible types and their members must be documented.
   Internal and private members may use doc comments but it is not required.
 
+* Documentation text should be written using complete sentences ending with full stops.
+
 ## Performance Considerations
 
 PowerShell has a lot of performance sensitive code as well as a lot of inefficient code.