有没有一种方法可以定义标准对象的属性的类型,并由Typedoc进行选择?

时间:2019-04-02 21:07:20

标签: javascript typescript class typedoc

我正在 TypeScript 中创建一个新类,其中有一个对象用于监视脚本中某些内容的状态。该对象深达两个级别。但是,当我在对象上运行 TypeDoc 时,它不会选择已定义的类型,而是假定它们是“ any”。我想我一定采取了一种非标准的方法来编码这个对象。我应该如何使用首选的 TypeScript 语法内联设置此对象,以便 TypeDoc 生成预期的文档?

起初,我尝试了预期的工作:

class ClassName {

    /**
    * A description of what this status is.
    */
    status: {
             /**
             * A description of what this property is.
             */
        pair: string[],
        db: {
            ready: boolean,
            interval: number
        }
    } = {
            pair: [], ...
    } ...
}

这没有用。 pair属性未在生成的文档中定义。接下来,我将 TypeDoc 的注释转换为我为对象属性设置的默认值:

class ClassName {

    /**
    * A description of what this status is.
    */
    status: {
        pair: string[],
        db: {
            ready: boolean,
            interval: number
        }
    } = {
             /**
             * A description of what this property is.
             */
            pair: [], ...
    } ...
}

之所以如此,是因为 TypeDoc 会将注释识别为引用了以下对象,但是将其定义为“ any”。在这一点上,我认为我没有遵循 TypeScript 中定义对象的标准方法,因为我找不到与这种定义类属性的方法相匹配的在线示例。

我了解可以使用接口创建文档。但是, TypeDoc 然后将每个 Interface 分隔到自己的页面中。这使得文档非常难以阅读。但这引出了一个后续问题,这是定义多级对象类属性的正确方法吗?

0 个答案:

没有答案