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

【问题标题】：Is there a way to describe a field in typedoc?有没有办法在 typedoc 中描述一个字段？
【发布时间】：2021-02-12 15:15:43
【问题描述】：

代码是：

/**
* Class description
*/

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

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

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

【问题讨论】：

【解决方案1】：

TSDoc 游乐场非常有限 - 它只会解析和显示它找到的第一个文档注释。有一个open issue，其他人也对其范围感到困惑。

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

【讨论】：