Schema documentation quick reference
Lookup for the source documentation card, which quotes every rule from the schema documentation contract. Function comments follow the same card and the function-comment template.
Where each kind of text goes
| Source | Holds |
|---|---|
TypeScript /// in the selected entry module, or Rust //! in src/lib.rs |
Package label and description |
JSDoc /** ... */ or Rust /// on a declaration or typed parameter |
That node's label (first ordinary line) and description |
Ordinary // comments |
Engineering notes; never localized |
Package StringResources |
Localized messages, permission reasons and other App text |
Rules: source and output, user language, exact source syntax, StringResources prose.
Property syntax
A custom property marker stands alone on its line after the ordinary text:
Text
[PropertyName]
Value through the line before the next marker or section end.
Rules: custom document properties.
Standard properties
[DefaultText]: initial task name on a function, or initial text on an effectiveStringorEndpointServerfield.[TrueText]and[FalseText]: labels of a Boolean field'strueandfalsechoices.[NullText]: caption of a nullable field's explicit null.[SetText]: label of a nullable field's value branch, the lead-in to the value.
Rules: standard properties.