如何存根TypeScript函数注释?

时间:2015-09-02 21:10:58

标签: javascript visual-studio-2013 typescript jsdoc

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

我安装了Web Essentials 2013.5和DocStubJs。目前,当我编写我的javascript时,我使用DocStubJs自动创建的C#-ish函数注释: enter image description here

我这样做主要是因为DocStubJs为我删除了评论。它(我假设它的DocStubJS正在做它)甚至也适用于TypeScript,我刚刚开始使用它,因为它很熟悉,而且大多数代码都是如此。但在查看了Typescript的更多文档后,我发现它们使用了JsDoc格式:

getMonthValue()

我应该使用哪种格式,XML-ish评论或DocJ?如果我去DocJs路线,无论如何能够自动删除评论吗?

2 个答案:

答案 0 :(得分:0)

更新2015年9月25日:今天在https://github.com/Microsoft/TypeScript/pull/4978中将更好的JsDoc脚手架添加到TypeScript主机中。如果您有冒险精神,欢迎您克隆回购邮件enable VS dev mode,并立即使用它。 :)

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

答案 1 :(得分:0)

使用JsDocs,因为XML注释在TypeScript中不能使用intellisense进行方法重载

同样只是想出键入/**会为你找出JsDoc评论。