Microsoft/alguidelines
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #71 from microsoft/waldo/guidelineCommentsSpacing

Browse source 
Comment Spacing
This commit is contained in:
Henrik Helgesen 2021-12-14 13:24:25 -08:00 • committed by GitHub
commit d0bbfcebed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

28
content/BCBestPractices/Readability/comments-spacing/index.md Normal file
View file

@ -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.