Skip to content
Beskid The Beskid Book

Beskid

Jump to a Beskid service

Beskid

Jump to a Beskid service

20.1 Doc comment syntax

/// runs, Markdown bodies, and structured @ directives.

Doc comment syntax

A documentation run is consecutive lines starting with /// where the third / is not followed by another /. Block comments and // lines are not API documentation—do not @inheritdoc your way around that.

Documentation attaches to top-level declarations and nested members (fields, variants, contract members, methods, parameters, and test-body statements where supported). Write Markdown in the body; use structured tags for machine-readable sections.

Documentation comments