Microsoft/bcquality
1
0
Fork 0
mirror of https://github.com/microsoft/BCQuality.git synced 2026-10-05 14:46:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
bcquality/microsoft/knowledge/style/block-keywords-start-new-line.md
Jesper Schulz-Wedde 2b5550c346
Some checks failed
Validate knowledge index / validate-index (push) Has been cancelled
Details
Validate AL review fixtures / validate-review-fixtures (push) Has been cancelled
Details
Validate frontmatter and structure / validate (push) Has been cancelled
Details
Improve partner onboarding and documentation navigation (#174) 
Lead with a complete plugin quick start and add task-oriented usage, troubleshooting, customization, and contribution guides. Preserve the broader plugin framing, correct conflicting contract guidance, support Agents folder reviews, and align repository validation. Convert existing sample references to clickable links without changing knowledge rules.

Co-authored-by: Jesper Schulz-Wedde <jesper.schulzwedde@microsoft.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-09-09 17:31:03 +02:00

1.6 KiB
Raw Blame History

bc-version domain keywords technologies countries application-area
all
style
block-keyword
end
if
repeat
until
for
while
case
aa0018
al
w1
all

Block keywords (end, if, repeat, until, for, while, case) start a new line (CodeCop AA0018)

Description

CodeCop AA0018 requires that the block-introducing keywords if, repeat, until, for, while, case, and the block-terminating keyword end always start a new line. Multiple statements packed onto one line — if A then X() else if B then Y(); written inline, or for i := 1 to 10 do begin X(i); Y(i); end; — defeat code review tooling that operates line-by-line and obscure the control flow. The rule does not prohibit short single-statement constructs spread across two lines (if Cond then X();); it prohibits packing the entire control structure onto one line.

Best Practice

Each if, else if, repeat, for, while, and case starts a line. Each end; (the closing of a begin … end block or a case) starts a line. Branch bodies are on their own line, indented.

See sample: block-keywords-start-new-line.good.al.

Anti Pattern

if IsContactName then ValidateContactName() else if IsSalespersonCode then ValidateSalespersonCode(); collapses an if/else if chain onto a single line; AA0018 flags both the else and the second if. The same applies to for i := 1 to 10 do begin DoX(i); DoY(i); end; — end is not at the start of its line.

See sample: block-keywords-start-new-line.bad.al.