mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-08-08 18:31:36 +01:00
Add CMFRT coding standards documentation and examples
- Introduced guidelines for "one codeunit one global function" architecture to enforce single responsibility in AL code. - Added best practices and anti-patterns for adding parameters via overloads to maintain backward compatibility. - Documented the importance of never deleting members in AL and always marking them as obsolete. - Established the requirement for OnBefore and OnAfter integration events for global procedures to enhance extensibility. - Defined naming conventions for CMFRT objects, including prefixes and object ID ranges to avoid conflicts. - Implemented patterns for case statements to ensure all cases are handled, including the necessity of an else clause. - Introduced the interface injection pattern to allow pluggable operations in table-level code. - Recommended using Confirm Management for user confirmations to improve testability. - Established a three-permission set pattern for security to ensure proper access control. - Created a review skill for CMFRT AL standards to automate compliance checks against established guidelines.
This commit is contained in:
parent
4119417ce4
commit
c72c0ad685
35 changed files with 866 additions and 0 deletions
29
custom/knowledge/naming/cmfrt-naming-prefix.bad.al
Normal file
29
custom/knowledge/naming/cmfrt-naming-prefix.bad.al
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
// Object names without the CMFRT prefix collide with other extensions.
|
||||
pageextension 2045661 "Job Card Extension" extends "Job Card"
|
||||
{
|
||||
}
|
||||
|
||||
// Unprefixed fields are indistinguishable from base application fields.
|
||||
tableextension 2045660 "Job Extension" extends Job
|
||||
{
|
||||
fields
|
||||
{
|
||||
field(2045081; "POI ID"; Guid)
|
||||
{
|
||||
DataClassification = CustomerContent;
|
||||
Caption = 'POI ID';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Unprefixed procedures have no ownership signal for reviewers.
|
||||
codeunit 2045700 "Job Management"
|
||||
{
|
||||
procedure LinkJobToPOI(JobNo: Code[20]; POIId: Guid)
|
||||
begin
|
||||
end;
|
||||
|
||||
local procedure ValidatePOIExists(POIId: Guid): Boolean
|
||||
begin
|
||||
end;
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue