1 个仓库
Tags used to explicitly document the default values of API members.
Distinct from Schema Default Values: Distinct from Schema Default Values: focuses on the documentation of the value rather than the runtime assignment.
Explore 1 awesome GitHub repository matching software engineering & architecture · Documentation Default Values. Refine with filters or upvote what's useful.
TSDoc 是一个用于在 TypeScript 代码中编写结构化注释的文档标准和规范。它提供了一个可移植的系统,用于在源代码中定义元数据、标签和交叉引用,以确保在不同工具链之间实现一致的解析和渲染。 该项目包含一个文档注释解析器,可将注释转换为结构化语法树,以及一个强制执行语法一致性的验证器。它允许通过外部配置文件定义自定义文档标签,并支持多种语法验证模式以协助规范合规性。 该规范涵盖了广泛的 API 文档需求,包括标记发布阶段、稳定性和弃用状态。它支持详细说明函数参数、返回值和异常类型,以及管理内部可见性、继承和声明之间的交叉引用。
Provides a standard way to specify the default value for a member in the documentation.