Kind: Type
Source: atloria-monorepo/libs/parser-core/src/openapi/doc-annotations.ts
Comment syntax an extractor must remove before the prose underneath is readable.
The artifacts matter more than they look: a leaked block terminator or a stray * column
ends up rendered verbatim in the playground, and a template literal's backticks turn the
rest of the summary into a code span. Every arm below is a thing that reached a published
spec.
Definition
ts| 'block'
/** `///` XML documentation comments — C#, F#, VB. */
| 'xmldoc'
/** `//` or `#` line runs — Go, Rust, Python comments, shell. */
| 'line'
/** `"""…"""` / `'''…'''` — Python docstrings. */
| 'docstring'
Was this page helpful?