2

このメソッドを含むクラスがあります

/**
* 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 がこのメソッドを文書化しないのはなぜ_ですか? それを削除すると、完全に文書化されます。この方法で JSDoc ドキュメントを作成するためにできることはありますか?

4

1 に答える 1

4

jsdoc-toolkit は、 で始まるメソッド_がプライベートであることを前提としています。これは確かに一般的な規則です。オプションで実行すると、メソッドが含まれていることがわかり--privateます。

ドキュメントを公開として強制するには、@publicタグを含めます。

ところで、 を使用する必要はありません@name。ほとんどの場合、関数の名前は自動的に検出されます。

于 2011-10-26T14:37:20.090 に答える