/// comments that are not lies

Informative guide. This Book page explains Beskid but does not define the standard. For normative requirements, use the Beskid Platform Specification.

Caution

This chapter is informative. Enforceable rules live under the Platform specification.

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.

Use this chapter to keep explanations, structured tags, generated API output, and review checks in one contributor loop. For exact language rules, start with Documentation comments; for generated package metadata, use the api.json contract.

What you will find here

| Section | Topic | | --- | --- | | Doc comment syntax | Doc runs and attachment rules. | | @arg and cross-links | Callable params only; @ref validation. | | Generated SDK docs | Mirrored compiler SDK sources. | | Verify docs | trudoc and CI presets. |

Tip

Make a documentation change part of the declaration’s review. A clear comment explains intent; the linked standard defines what the toolchain accepts and emits.

Next

21. FFI and forbidden friendships