javascript - 如何让 JSDoc 记录我的 _methods？

Question

我有一个包含这个方法的类

/**
* Uses the native RegExp object and the native string.replace to replace text
* @name _replace
* @param {String} find Text string or regex to search for
* @param {String} replace Text string or regex for replacing
* @param {String} string   String to perfom the replace on
* @returns {String} Returns the string with the text replaced
*/  
this._replace = function(find, replace, str) {
    var regex;

    if(typeof find !== undefined && replace !== undefined && typeof str === 'string') {
        regex = new RegExp(find, this._getFlags()); 
        return str.replace(regex, replace, str);            
    } else {
        return false;
    }

};

它带有前缀_以将其与replace用于公共接口的方法区分开来。为什么 JSDoc_前面有 a 时不记录这个方法？如果我删除它，它会完美地记录下来。我能做些什么来让 JSDoc 记录这个方法吗？

Answer 1

jsdoc-toolkit 假定以 开头的方法_是私有的。这确实是一种常见的约定。--private您可以通过使用选项运行看到该方法已包含在内。

要强制将其记录为公开，请包含@public标签。

顺便说一句，您不需要使用@name，在大多数情况下会自动检测函数的名称。