Как получить JSDoc для документирования моих _методов? - PullRequest
Новая
       12

Как получить JSDoc для документирования моих _методов?

2 голосов
/ 11 октября 2011

У меня есть класс, который содержит этот метод 

/**
* 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 документировал этот метод?

1 Ответ

4 голосов
/ 26 октября 2011

jsdoc-toolkit предполагает, что методы, начинающиеся с _, являются закрытыми. Это действительно общее соглашение. Вы можете увидеть, что метод включен, запустив с опцией --private.

Чтобы принудительно задокументировать его как общедоступный, добавьте тег @public.

Кстати, вам не нужно использовать @name, название функции определяется автоматически в большинстве случаев.

...