From a8d3fb30892a814303f3569d4e76f8755befecd3 Mon Sep 17 00:00:00 2001 From: waldo1001 Date: Sat, 11 Dec 2021 08:54:31 +0100 Subject: [PATCH 1/2] Comment Spacing --- .../BCBestPractices/comments-spacing/index.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 content/BCBestPractices/comments-spacing/index.md diff --git a/content/BCBestPractices/comments-spacing/index.md b/content/BCBestPractices/comments-spacing/index.md new file mode 100644 index 00000000..87c99b20 --- /dev/null +++ b/content/BCBestPractices/comments-spacing/index.md @@ -0,0 +1,28 @@ ++++ +title = "Comment Spacing" +weight = 360 ++++ + +<_Created by Microsoft, Described by waldo_\> + +## Description +Always start comments with // followed by one space character. + +## Bad code + +```al +RowNo += 1000; //Move way below the budget +``` + + +## Good code + +```al +RowNo += 1000; // Move way below the budget +``` + +## [Discussions](https://github.com/microsoft/alguidelines/discussions/categories/bc-best-practices?discussions_q=comment+spacing+category%3A%22BC+Best+Practices%22) + +You can find discussions on all "Best Practices" [here](https://github.com/microsoft/alguidelines/discussions/categories/bc-best-practices). + +If you don't find the discussion of this guideline, please feel fee to create a new one with the same title as this article. \ No newline at end of file From fc88ff781d796ed55d07d250cb4c44410c532bde Mon Sep 17 00:00:00 2001 From: waldo1001 Date: Sat, 11 Dec 2021 13:30:49 +0100 Subject: [PATCH 2/2] Move --- .../BCBestPractices/{ => Readability}/comments-spacing/index.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename content/BCBestPractices/{ => Readability}/comments-spacing/index.md (100%) diff --git a/content/BCBestPractices/comments-spacing/index.md b/content/BCBestPractices/Readability/comments-spacing/index.md similarity index 100% rename from content/BCBestPractices/comments-spacing/index.md rename to content/BCBestPractices/Readability/comments-spacing/index.md