Function-comment template
Shape for a public function's comment. The source documentation card quotes every rule from the developer function-comment guide, including its seven completeness categories, the actor, action and scope wording and the attribution.
Attribution
End every codebot-generated description with exactly:
Text
Developed by Display Name (account_name).
Before the developer has a Plaza account:
Text
Developed by account_name.
Template
Text
Concise activity name
The domain actor performs the main activity under its material condition.
The user chooses the applicable setup values and their scope.
The user can perform the applicable controls or overrides.
The domain actor automatically performs applicable behavior and says what
influences it.
The App shows, records, summarizes, or delivers applicable results and states
material prerequisites or limits.
Developed by Display Name (account_name).
Omit inapplicable sentences; never invent behavior. The guide's example shows a complete comment in Rust and TypeScript.