新的JSDoc。在JSDoc中記錄事件處理程序的最佳方法是什麼？

Question

假設我有一個這樣的類：

function myClass(q) { 
    this.someFunction = function(e) { 
     console.log("Click event"); 
    }; 

    jQuery(q).click(this.someFunction); 
} 

有沒有一種方法來指示JSDoc那someFunction不僅是應該直接調用的函數而是一個事件處理程序？我看到了@event標籤，但是如果我理解正確，這更多的是在我的類中記錄一個我認爲是事件的函數（客戶端代碼也會註冊，並且我的類將在需要時觸發），而不是事件處理函數功能？

謝謝

Answer 1

不，沒有辦法記錄事件處理程序。

因此，最好的方法是將其記錄爲正常功能，可能會在其描述中以粗體文本或大寫形式書寫「EVENT HANDLER」。

您現在可能已經這樣做了，但以防萬一：您可以通過將文本簡單地包裝到html標記<strong></strong>中來將其寫入粗體。

Answer 2

關鍵字是@listens

用例：

/** 
* Outputs the event that happened 
* 
* @param {MyEvent} e - The observable event. 
* @listens MyEvent 
*/ 
function myEventLogger(e) { 
    console.log(e); 
} 

的必然結果是對引發事件的@fires關鍵字。