Fatal编程技术网
  • javascript/
  • Javascript 如何让JSDoc记录my\u方法？

Javascript 如何让JSDoc记录my\u方法？

javascript documentation

Javascript 如何让JSDoc记录my\u方法？,javascript,documentation,jsdoc,Javascript,Documentation,Jsdoc,我有一个包含此方法的类 /** * 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} st

我有一个包含此方法的类

/**
* 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;
    }

};
它的前缀是
。
，以区别于用于公共接口的
替换方法。为什么JSDoc在前面有一个
\uu
时不记录这个方法？如果我移除它，它会完美地记录下来。我能做些什么来让JSDoc记录这个方法吗？
JSdocToolkit假设以
开头的方法是私有的。这确实是一个共同的惯例。您可以看到，通过使用
--private
选项运行，包含了该方法

要强制将其记录为公共文件，请包含
@public
标记


顺便说一句，您不需要使用
@name
，大多数情况下会自动检测函数名。
非常好，谢谢。我已经放弃了对这个问题的回答。这是不寻常的。