[F] $doc

function $doc(
   context,
   target,
   doc,
   formatArgs?): void

Parameters

Parameter	Type
context	DecoratorContext
target	Type
doc	string
formatArgs?	Type

Returns

void

Doc

attaches a documentation string. Works great with multi-line string literals.

The first argument to

Doc

is a string, which may contain template parameters, enclosed in braces, which are replaced with an attribute for the type (commonly “name”) passed as the second (optional) argument.

Doc

can be specified on any language element — a model, an operation, a namespace, etc.