角2 jsDoc用於構造

Question

在我的角類（打字稿）我有一個構造函數：

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

這是正確的方式進行jsDoc評論此構造函數的參數？

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

Answer 1

我想你可以忽略@constructor標記，因爲jsDoc能夠通過解析你的代碼來判斷這些信息。在這裏檢查樣品：howto es2015 classes

作爲一個方面說明。

我發現以下實用程序可以爲打字稿項目創建文檔：TypeDoc 它支持與jsDoc相同的語法並可與打字稿很好地配合使用。

希望這會有所幫助。