是否可以在JSDoc中記錄一個本地未定義的函數？

Question

我在代碼中有幾次的基本模式是exports.thing = thingFromSomewhereElse，我想記錄thingFromSomewhereElse的函數成員，就像我自己定義它們一樣。但我不明白如果沒有實際的thing.functionName = function() {...}這樣做怎麼辦。如果我嘗試使用@callback標記，JSDoc會將它歸類爲類型定義而不是成員。有沒有辦法讓它正確顯示爲對象成員？

Answer 1

這可以通過使用@name JSDoc標籤來完成。該標籤旨在用於爲JSDoc無法識別的內容撰寫評論。 @kind標籤也應該用於指示被記錄的內容實際上是一個函數，以便像@param和@return這樣的函數特定標籤正常工作。對於給出的例子，該功能將被記錄爲具有如下評論：

/** 
* Description of the function 
* @name thing.functionName 
* @kind function 
* @param ... 
* @return ... 
*/