📄️ Block Tags
- @remarks -- Additional information about the API.
📄️ TSDoc-Download-Log
🕓 TSDoc sync @ 2025-07-23T0443.387Z
📄️ TSDoc-Home
TSDoc is a proposal to standardize the doc comments used in
📄️ TSDoc-Intro-Approach
The TSDoc specification aims to meet these requirements:
📄️ TSDoc-Intro-UsingTsdoc
By itself, the @microsoft/tsdoc package is not a documentation
📄️ TSDoc-Package-EslintPluginTsdoc
[NPM
📄️ TSDoc-Package-Tsdoc
[NPM
📄️ TSDoc-Package-TsdocConfig
[NPM
📄️ TSDoc-Spec-Overview
Technical details for the TSDoc syntax are tracked by "RFC" issues with
📄️ TSDoc-Spec-StandardizationGroups
Three "standardization groups" are used to classify the standard TSDoc
📄️ TSDoc-Spec-TagKinds
TSDoc distinguishes three kinds of tags: Block tags, modifier tags, and
📄️ @alpha
| | |
📄️ @beta
| | |
📄️ @decorator
| | |
📄️ @defaultValue
| | |
📄️ @deprecated
| | |
📄️ @eventProperty
| | |
📄️ @example
| | |
📄️ @experimental
| | |
📄️ @inheritDoc
| | |
📄️ @internal
| | |
📄️ @label
| | |
📄️ @link
| | |
📄️ @override
| | |
📄️ @packageDocumentation
| | |
📄️ @param
| | |
📄️ @privateRemarks
| | |
📄️ @public
| | |
📄️ @readonly
| | |
📄️ @remarks
| | |
📄️ @returns
| | |
📄️ @sealed
| | |
📄️ @see
| | |
📄️ @throws
| | |
📄️ @typeParam
| | |
📄️ @virtual
| | |