From 077e4e992353878a8a78f83c81c8d0ed046efa55 Mon Sep 17 00:00:00 2001 From: xtqqczze Date: Fri, 4 Dec 2020 11:54:36 +0000 Subject: [PATCH 1/3] Add documentation comments section * Add new documentation comments section * Retarget doc comments link to conceptual article --- docs/dev-process/coding-guidelines.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/dev-process/coding-guidelines.md b/docs/dev-process/coding-guidelines.md index 389981c3f7b..7c82c447973 100644 --- a/docs/dev-process/coding-guidelines.md +++ b/docs/dev-process/coding-guidelines.md @@ -86,8 +86,13 @@ 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/). - Internal and private members may use doc comments but it is not required. +### 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. + +* Documentation text should be written using complete sentences ending with full stops. ## Performance Considerations From ee981f8ed9330c46ac9d67e8bc905f30716eab93 Mon Sep 17 00:00:00 2001 From: xtqqczze Date: Sat, 5 Dec 2020 14:02:29 +0000 Subject: [PATCH 2/3] Add `IntelliSense` to dictionary --- .spelling | 1 + 1 file changed, 1 insertion(+) diff --git a/.spelling b/.spelling index 89f6593204d..96d55a2ed74 100644 --- a/.spelling +++ b/.spelling @@ -383,6 +383,7 @@ includeusername informationrecord initializers install-packageprovider +IntelliSense interactivetesting interop interoperation From 67c4f44c50cda605654731eb089777e307a99cfd Mon Sep 17 00:00:00 2001 From: Aditya Patwardhan Date: Mon, 19 Apr 2021 14:00:06 -0400 Subject: [PATCH 3/3] Update suggestion Co-authored-by: Ilya --- docs/dev-process/coding-guidelines.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/dev-process/coding-guidelines.md b/docs/dev-process/coding-guidelines.md index 7c82c447973..9bf46aee02d 100644 --- a/docs/dev-process/coding-guidelines.md +++ b/docs/dev-process/coding-guidelines.md @@ -91,6 +91,7 @@ We also run the [.NET code formatter tool](https://github.com/dotnet/codeformatt * 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.