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

Is there a way to describe a field in typedoc?

密码是:

/**
* Class description
*/

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

我正在 TSDoc playground 上查看它,发现有 class 的摘要,但它的字段

没有摘要

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

TSDoc 游乐场极其有限——它只会解析并显示它找到的第一个文档评论。有一个 open issue,其他人也对其范围感到困惑。

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