0
如果我的代碼創建了一個ECMAScript的前6風格的「類」,即一個構造函數是這樣的:用JSDoc 3語法指定對象類的正確方法是什麼?
function MyDBPlugin() {
// ...
}
,我使用了JSDoc3方案來記錄另一個函數,它的MyDBPlugin
的實例作爲論據,我該如何表示MyDBPlugin
對象?
我的第一個猜測是這樣的:
/**
* Some function which takes an instance of MyDBPlugin as an argument
*
* @param {Object} plugin An instance of the MyDBPlugin class
*/
function query_database(plugin) {
// ...
}
但{Object}
似乎相當不提供信息,似乎使用的類名,{MyDBPlugin}
會更具描述性的,如:
/**
* Some function which takes an instance of MyDBPlugin as an argument
*
* @param {MyDBPlugin} plugin An instance of the MyDBPlugin class
*/
function query_database(plugin) {
// ...
}
我怎麼代表在MyDBPlugin
對象JSDoc語法?
謝謝,因爲我的例子是一個類,這是否意味着我可以馬上使用它,即我不是必需的創建一個'@ typedef'? –
@the_velour_fog如果你只記錄你的班級,我認爲它應該沒問題 – Oskar