如何解决有没有办法在 typedoc 中描述一个字段?
代码是:
/**
* Class description
*/
export class SomeClass {
/**
* The field description
*/
message: string;
}
我在 TSDoc playground 上检查它,看到有类的摘要,但没有其字段的摘要
有没有办法在 typedoc 中描述一个字段?
解决方法
TSDoc playground 非常有限——它只会解析并显示它找到的第一个文档评论。有一个 open issue,其他人也对其范围感到困惑。
TypeDoc 与 TSDoc 不是一回事。 TSDoc 是一个最终会被 TypeDoc 采用的文档注释标准,而 TypeDoc 是一个文档生成器。如果您为 TypeDoc 提供该类(假设它是导出的),那么它将正确地将其记录为具有属性 message
的类,该类具有所提供的描述。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。