有没有办法在 typedoc 中描述一个字段？

Question

代码是：

/**
* Class description
*/

export class SomeClass {
  /**
   * The field description
   */
  message: string;
}

我在 TSDoc playground 上检查它，看到有类的摘要，但没有其字段的摘要

有没有办法在 typedoc 中描述一个字段？

Answer 1

TSDoc playground 非常有限——它只会解析并显示它找到的第一个文档评论。有一个 open issue，其他人也对其范围感到困惑。

TypeDoc 与 TSDoc 不是一回事。 TSDoc 是一个最终会被 TypeDoc 采用的文档注释标准，而 TypeDoc 是一个文档生成器。如果您为 TypeDoc 提供该类（假设它是导出的），那么它将正确地将其记录为具有属性 message 的类，该类具有所提供的描述。