【问题标题】:Inherit xml documentation on overloaded functions in typescript继承关于 typescript 中重载函数的 xml 文档
【发布时间】:2014-11-10 08:18:02
【问题描述】:

有没有办法让重载函数继承与其基类相同的 xml 文档?

悬停在 myFunc 上

将鼠标悬停在 myFunc 上,我想查看基类文档,而不仅仅是 (): void

这可能吗还是我必须在子类中单独写?

【问题讨论】:

    标签: inheritance typescript xml-documentation


    【解决方案1】:

    每当您处理 Base 类型时,文档都会显示,其中包括以下内容:

    var klas: Base = new Klas();
    

    您将获得此实例中的文档。

    如果您在使用 Klas 时需要文档,请在您的类中添加以下注释...

    /**
     * @constructor
     * @augments Base
     */
    public class Klas {...
    

    这会将文档从Base 拉入Klas 类型。这比复制所有单独的文档要容易得多。

    【讨论】:

    • 第一部分工作正常,但这是我正在寻找的第二部分。但是,它不起作用......我还缺少什么其他需要的东西?
    • 可能是您的 IDE 不支持它。你可以在这里看到它的工作原理:bit.ly/1oBima7
    • 在您的示例中,Sub 没有重载实现。有没有办法获取重载函数的基本文档?
    • 当你重写一个方法时,你需要提供新的文档,大概是因为你必须描述为什么它与基础实现不同。
    • 对,但我有一个场景,我希望重载函数具有基本文档。这是不可能的?重载的函数里还要写一遍吗?
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2023-04-04
    • 1970-01-01
    • 2015-05-24
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多