Skip to content
Beskid The Beskid Book

Beskid

Jump to a Beskid service

Beskid

Jump to a Beskid service

20. /// comments that are not lies

Documentation comments, @arg on callables only, generated SDK docs, and CI verification.

/// comments that are not lies

Documentation lives next to declarations in /// line comments only—no XML novel, no separate doc assembly that drifts from the code every sprint. If the comment disagrees with the compiler, the compiler wins.

SectionTopic
Doc comment syntaxDoc runs and attachment rules.
@arg and cross-linksCallable params only; @ref validation.
Generated SDK docsMirrored compiler SDK sources.
Verify docstrudoc and CI presets.

21. FFI and forbidden friendships