mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-08-07 18:06:53 +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
31
custom/knowledge/patterns/cmfrt-interface-injection.good.al
Normal file
31
custom/knowledge/patterns/cmfrt-interface-injection.good.al
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
// Step 1: Interface with a single procedure.
|
||||
interface "CMFRT MS ICalcTotals"
|
||||
{
|
||||
procedure CMFRTMSCalcTotals(var MeasureState: Record "CMFRT MS Measure State");
|
||||
}
|
||||
|
||||
// Step 2 & 3: Base-table entry point and interface-accepting overload.
|
||||
table 2045090 "CMFRT MS Measure State"
|
||||
{
|
||||
procedure CalcTotals()
|
||||
var
|
||||
DefaultImpl: Codeunit "CMFRT MS CalcTotals Impl";
|
||||
Handled: Boolean;
|
||||
begin
|
||||
OnBeforeDefaultImplCalcTotals(Rec, Handled);
|
||||
if Handled then
|
||||
exit;
|
||||
CalcTotals(DefaultImpl);
|
||||
end;
|
||||
|
||||
procedure CalcTotals(CalcImpl: Interface "CMFRT MS ICalcTotals")
|
||||
begin
|
||||
CalcImpl.CMFRTMSCalcTotals(Rec);
|
||||
end;
|
||||
|
||||
// Step 4: OnBefore event with Handled pattern.
|
||||
[IntegrationEvent(false, false)]
|
||||
local procedure OnBeforeDefaultImplCalcTotals(var Ms: Record "CMFRT MS Measure State"; var Handled: Boolean)
|
||||
begin
|
||||
end;
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue