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

Merge branch 'main' into merge-blank-lines-best-practices

Browse source
This commit is contained in:
Christian Bräunlich 2022-05-16 20:34:46 +02:00
commit d3e38aa74a
8 changed files with 79 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

19
content/docs/BestPractices/begin-end/index.md
View file

@ -8,7 +8,9 @@ _Created by Microsoft, Described by waldo_
Only use begin..end to enclose [compound statements](https://docs.microsoft.com/en-us/cpp/c-language/compound-statement-c?view=msvc-170#:~:text=A%20compound%20statement%20%28also%20called%20a%20%22block%22%29%20typically,appear%20at%20the%20head%20of%20a%20compound%20statement.). Only use begin..end to enclose [compound statements](https://docs.microsoft.com/en-us/cpp/c-language/compound-statement-c?view=msvc-170#:~:text=A%20compound%20statement%20%28also%20called%20a%20%22block%22%29%20typically,appear%20at%20the%20head%20of%20a%20compound%20statement.).
## Bad code ## Example 1
### Bad code
```AL ```AL
if FindSet() then begin if FindSet() then begin
@ -18,7 +20,7 @@ if FindSet() then begin
end; end;
``` ```
## Good code ### Good code
```AL ```AL
if FindSet() then if FindSet() then
@ -27,7 +29,9 @@ if FindSet() then
until next() = 0; until next() = 0;
``` ```
## Bad code ## Example 2
### Bad code
```AL ```AL
if IsAssemblyOutputLine then begin if IsAssemblyOutputLine then begin
@ -35,7 +39,7 @@ if IsAssemblyOutputLine then begin
end; end;
``` ```
## Good code ### Good code
```AL ```AL
if IsAssemblyOutputLine then if IsAssemblyOutputLine then
@ -52,3 +56,10 @@ if X then begin
end else end else
(not X) (not X)
``` ```
## Tips
The [AZ AL Dev Tools/AL Code Outline](https://marketplace.visualstudio.com/items?itemName=andrzejzwierzchowski.al-code-outline) extension adds two new commands to Visual Studio Code to remove begin..end around single statements.
- `Remove Begin..End around Single Statements from the Active Editor` : removes begin..end around single statement from the current editor
- `Remove Begin..End around Single Statements from the Active Project` : removes begin..end around single statement from the current project

7
content/docs/BestPractices/blank-lines/index.md
View file

@ -106,3 +106,10 @@ local procedure OnAfterGetGLSetup(var GLSetup: Record "General Ledger Setup")
begin begin
end; end;
``` ```
## Tips
The [AZ AL Dev Tools/AL Code Outline](https://marketplace.visualstudio.com/items?itemName=andrzejzwierzchowski.al-code-outline) extension adds two new commands to Visual Studio Code to remove empty duplicate lines.
- `Remove Empty Lines from the Active Editor` : removes empty duplicate lines from the current editor
- `Remove Empty Lines from the Active Project` : removes empty duplicate lines from the current project

6
content/docs/BestPractices/named-invocations/index.md
View file

@ -21,3 +21,9 @@ When calling an object statically use the Object Name, not the Object Id.
```al ```al
Page.RunModal(Page::"Posted Sales Shipment Lines", SalesShptLine); Page.RunModal(Page::"Posted Sales Shipment Lines", SalesShptLine);
``` ```
## Tips
The [BusinessCentral.LinterCop](https://marketplace.visualstudio.com/items?itemName=StefanMaron.businesscentral-lintercop) extension adds a new rule to check your code for hardcoded object IDs.
- [LC0012](https://github.com/StefanMaron/BusinessCentral.LinterCop/wiki/LC0012): Using hardcoded IDs in functions like Codeunit.Run() is not allowed.

12
content/docs/BestPractices/one-statement-per-line/index.md
View file

@ -10,26 +10,30 @@ _Created by Microsoft, Described by waldo_
A line of code should not have more than one statement. A line of code should not have more than one statement.
## Bad code ## Example 1
### Bad code
```al ```al
if OppEntry.Find('-') then exit; if OppEntry.Find('-') then exit;
``` ```
## Good code ### Good code
```al ```al
if OppEntry.Find('-') then if OppEntry.Find('-') then
exit; exit;
``` ```
## Bad code ## Example 2
### Bad code
```al ```al
TotalCost += Cost; TotalAmt += Amt; TotalCost += Cost; TotalAmt += Amt;
``` ```
## Good code ### Good code
```al ```al
TotalCost += Cost; TotalCost += Cost;

18
content/docs/BestPractices/spacing-binary-operators/index.md
View file

@ -10,37 +10,43 @@ _Created by Microsoft, Described by waldo_
There must be exactly one space character on each side of a binary operator such as = + - AND OR =. The parameter comma operator however, should have a space after the comma. There must be exactly one space character on each side of a binary operator such as = + - AND OR =. The parameter comma operator however, should have a space after the comma.
## Bad code ## Example 1
### Bad code
```al ```al
"Line Discount %" := "Line Discount Amount"/"Line Value"*100; "Line Discount %" := "Line Discount Amount"/"Line Value"*100;
``` ```
## Good code ### Good code
```al ```al
"Line Discount %" := "Line Discount Amount" / "Line Value" * 100; "Line Discount %" := "Line Discount Amount" / "Line Value" * 100;
``` ```
## Bad code ## Example 2
### Bad code
```al ```al
StartDate := CalcDate('<+'+Format(Days+i)+'D\>',StartDate); StartDate := CalcDate('<+'+Format(Days+i)+'D\>',StartDate);
``` ```
## Good code ### Good code
```al ```al
StartDate := CalcDate('<+' + Format(Days + i) + 'D\>', StartDate); StartDate := CalcDate('<+' + Format(Days + i) + 'D\>', StartDate);
``` ```
## Bad code ## Example 3
### Bad code
```al ```al
StartDate:=0D; // Initialize StartDate:=0D; // Initialize
``` ```
## Good code ### Good code
```al ```al
StartDate := 0D; // Initialize StartDate := 0D; // Initialize

12
content/docs/BestPractices/unnecessary-truefalse/index.md
View file

@ -9,25 +9,29 @@ _Created by Microsoft, Described by waldo_
## Description ## Description
Do not use `true` or `false` keywords unnecessarily if the expression is already an logical expression. Do not use `true` or `false` keywords unnecessarily if the expression is already an logical expression.
## Bad code ## Example 1
### Bad code
```al ```al
if IsPositive() = true then if IsPositive() = true then
``` ```
## Good code ### Good code
```al ```al
if IsPositive() then if IsPositive() then
``` ```
## Bad code ## Example 2
### Bad code
```al ```al
if Complete <> true then if Complete <> true then
``` ```
## Good code ### Good code
```al ```al
if not Complete then if not Complete then

22
content/docs/BestPractices/variable-naming/index.md
View file

@ -16,38 +16,48 @@ Blanks, periods, and other characters (such as parentheses) that would make quot
If a variable is a compound of two or more words or abbreviations, each word or abbreviation should begin with a capital letter. If a variable is a compound of two or more words or abbreviations, each word or abbreviation should begin with a capital letter.
## Bad code ## Example 1
### Bad code
```al ```al
WIPBuffer: Record "Job WIP Buffer" WIPBuffer: Record "Job WIP Buffer"
``` ```
## Good code ### Good code
```al ```al
JobWIPBuffer: Record "Job WIP Buffer" JobWIPBuffer: Record "Job WIP Buffer"
``` ```
## Bad code ## Example 2
### Bad code
```al ```al
Postline: Codeunit "Gen. Jnl.-Post Line"; Postline: Codeunit "Gen. Jnl.-Post Line";
``` ```
## Good code ### Good code
```al ```al
GenJnlPostLine: Codeunit "Gen. Jnl.-Post Line"; GenJnlPostLine: Codeunit "Gen. Jnl.-Post Line";
``` ```
## Bad code ## Example 3
### Bad code
```al ```al
"Amount (LCY)": Decimal; "Amount (LCY)": Decimal;
``` ```
## Good code ### Good code
```al ```al
AmountLCY: Decimal; AmountLCY: Decimal;
``` ```
## Tips
The [AL Variable Helper](https://marketplace.visualstudio.com/items?itemName=rasmus.al-var-helper) extension provides Intellisense support to assign correct variable names in AL.

7
content/docs/BestPractices/variables-declarations-order/index.md
View file

@ -39,3 +39,10 @@ Variables declarations should be ordered by type. In general, object and complex
Vendor: Record Vendor; Vendor: Record Vendor;
StartingDateFilter: Text; StartingDateFilter: Text;
``` ```
## Tips
The [AZ AL Dev Tools/AL Code Outline](https://marketplace.visualstudio.com/items?itemName=andrzejzwierzchowski.al-code-outline) extension adds two new commands to Visual Studio Code to sorts variables.
- `Sort Variables in the Active Editor` : sorts variables in the current editor
- `Sort Variables in the Active Project` : sorts variables in the current project