mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-08-06 09:26:52 +01:00
Add 12 atomic knowledge articles under microsoft/knowledge/events covering general AL event-design best practices: IsHandled initialization and OnAfter preservation, appending new event parameters, position-based event naming, reusing/extending events, avoiding per-iteration publishing, Temp-prefixing temporary record parameters, unabbreviated parameter names, preferring the this keyword over IncludeSender, avoiding loosely typed parameters, not mutating existing event contracts, and not bypassing critical operations with IsHandled. Each article ships a .good.al and .bad.al demonstration sample (object IDs 50240-50296; not compiled by CI). Extend the al-events-review leaf Worklist with one targeted check per new rule. Additive only; no contract or wiring change (events leaf already wired). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
21 lines
799 B
AL
21 lines
799 B
AL
// Demonstration-only AL. Not compiled by CI; illustrates the article.
|
|
codeunit 50251 "Param Append Bad Sample"
|
|
{
|
|
procedure PostDocument(var SalesHeader: Record "Sales Header"; CalledFromBatch: Boolean)
|
|
var
|
|
IsHandled: Boolean;
|
|
begin
|
|
IsHandled := false;
|
|
// Anti-pattern: 'CalledFromBatch' was inserted before the existing
|
|
// IsHandled parameter, shifting it and breaking the argument positions
|
|
// every existing subscriber relied on.
|
|
OnBeforePostDocument(SalesHeader, CalledFromBatch, IsHandled);
|
|
if IsHandled then
|
|
exit;
|
|
end;
|
|
|
|
[IntegrationEvent(false, false)]
|
|
local procedure OnBeforePostDocument(var SalesHeader: Record "Sales Header"; CalledFromBatch: Boolean; var IsHandled: Boolean)
|
|
begin
|
|
end;
|
|
}
|