Angularjs 构造函数的角度2 jsDoc
在Angular类(Typescript)中,我有一个构造函数:Angularjs 构造函数的角度2 jsDoc,angularjs,typescript,angular,jsdoc,Angularjs,Typescript,Angular,Jsdoc,在Angular类(Typescript)中,我有一个构造函数: constructor(public http: Http) { [...] } 这是jsDoc对该构造函数的参数进行注释的正确方法吗 /** * @constructor * @param {Http} Http service * called when the ApiService is created */ 我认为您可以省略@constructor标记,因为jsDoc能够通过
constructor(public http: Http) {
[...]
}
这是jsDoc对该构造函数的参数进行注释的正确方法吗
/**
* @constructor
* @param {Http} Http service
* called when the ApiService is created
*/
我认为您可以省略@constructor标记,因为jsDoc能够通过解析代码来判断这些信息。在此处检查样本: 作为旁注 我发现以下实用程序对于为typescript项目创建文档很有用: 它支持与jsDoc相同的语法,并且可以很好地使用typescript
希望这能有所帮助。我尝试了TypeDoc,这会引发另一个问题。它找不到我的Angular模块:关于我的问题,我很好奇如何定义
@param{Http}Http服务
,因为它是一个可注入的,我认为这至少在jsDoc中是不可能的。不过,作为一种变通方法,您不会被迫对可注入服务使用这种语法。您可以声明公共属性“http”并在构造函数中手动初始化它,构造函数的签名类似于:constructor(http:http){this.http=http;}。这将允许您使用常用的文档标记。