小编典典

TypeScript 注释的语法记录在哪里?

all

TypeScript 注释的语法是否记录在任何地方?

而且,它现在是否支持 C#///系统?


阅读 69

收藏
2022-06-15

共1个答案

小编典典

2020 年 11 月更新

一个网站现在在线,所有可用的 TSDoc 语法(这太棒了):https ://tsdoc.org/


供参考,旧答案

正确的语法现在是 TSDoc使用的语法。它将允许您让 Visual
Studio Code 或其他文档工具理解您的评论。

此处尤其是此处提供了对语法的一个很好的概述。准确的规格应该“很快”写出来

另一个值得检查的文件是这个文件,您将在其中看到有用的标准标签。

注意 :您不应该使用 JSDoc,如 TSDoc 主页所述: 为什么 JSDoc 不能成为标准? 不幸的是,JSDoc
语法没有严格指定,而是从特定实现的行为中推断出来的。大多数标准 JSDoc 标记都专注于为纯 JavaScript 提供类型注释,这与 TypeScript
等强类型语言无关。TSDoc 解决了这些限制,同时还解决了一组更复杂的目标。

2022-06-15