如何存根 TypeScript 函数注释？答案

【问题标题】：How To Stub TypeScript Function Comments?如何存根 TypeScript 函数注释？
【发布时间】：2015-09-26 07:37:46
【问题描述】：

我正在运行 VS2013，我刚刚开始使用 TypeScript。

我安装了 Web Essentials 2013.5 和 DocStubJs。目前，当我编写我的 javascript 时，我使用由 DocStubJs 自动创建的 C#-ish 函数 cmets：

我这样做主要是因为 DocStubJs 为我删除了评论。它（我假设它是 DocStubJS 做的）甚至在 TypeScript 中也可以工作，我刚开始使用它，因为它很熟悉，而且无论如何都是大多数代码的内容。但是在查看了更多关于 Typescript 的文档后，我发现他们使用了 JsDoc 格式：

    /**
     * Does stuff
     *
     * @param blah stuff needing done
     */
    public doStuff(blah: string) {}

我应该使用哪种格式，XML 风格的注释，还是 DocJs？如果我走 DocJs 路线，有没有办法自动剔除 cmets？

【问题讨论】：

【解决方案1】：

使用 JsDocs，因为 XML 注释不能与智能感知一起用于 TypeScript 中的方法重载

还刚刚发现键入 /** 会为您删除 JsDoc 评论。

【讨论】：

【解决方案2】：

2015 年 9 月 25 日更新：更好的 JsDoc 脚手架今天在 https://github.com/Microsoft/TypeScript/pull/4978 添加到 TypeScript 母版。如果您喜欢冒险，欢迎您克隆 repo，enable VS dev mode，并立即使用它。 :)

使用 JsDoc 路线。 TypeScript 团队正在为即将发布的版本添加对 JsDoc 的支持，其中包括类型信息、智能感知和脚手架。使用TS 1.6 beta，脚手架现在可以使用functions。未来可能会增加更多支持。

【讨论】：