角2 jsDoc用于构造

在我的角类（打字稿）我有一个构造函数：角2 jsDoc用于构造

constructor(public http: Http) { 
    [...] 
    }

这是正确的方式进行jsDoc评论此构造函数的参数？

/** 
    * @constructor 
    * @param {Http} Http service 
    * called when the ApiService is created 
    */

来源

2016-01-26 Bas van Dijk

我想你可以忽略@constructor标记，因为jsDoc能够通过解析你的代码来判断这些信息。在这里检查样品：howto es2015 classes

作为一个方面说明。

我发现以下实用程序可以为打字稿项目创建文档：TypeDoc 它支持与jsDoc相同的语法并可与打字稿很好地配合使用。

希望这会有所帮助。

来源

2016-01-26 14:19:29 Amid

我试过TypeDoc，这引发了另一个问题。它没有找到我的Angular模块：http://stackoverflow.com/questions/35015994/typedoc-can-not-find-angular2-modules –

关于我的问题，我很好奇如何定义'@param {Http} Http服务'因为它是一个可注射的 –

我认为这将是不可能与jsDoc至少现在。作为一个解决方法，虽然 - 你没有被迫使用这种语法来注入服务。您可以声明公共属性'http'并手动将其初始化为构造函数，构造函数具有如下构造函数：构造函数（http：Http）{this.http = http;}。这将允许您使用通常的文档标签。 – Amid

角2 jsDoc用于构造

回答

相关问题