jsdoc- все статьи тега
Как вернуть void в JsDoc?
есть ли указанный способ объявить метод или функцию для возврата void в JsDoc? В настоящее время я убежден, что void - возвращаемое значение по умолчанию, и другие возвращаемые значения должны быть специально указаны: /** * @return {Integer} The identifier for ... */ ...
Как легко создать GitHub дружественный markdown для документированных функций JavaScript?
Я хочу иметь возможность принимать комментарии JSDoc, как это в любом месте в источнике JavaScript (даже вложенные вниз несколько слоев функций, в модуле или даже анонимных функций): /** * Used to do some important thing that needs doing that works like xyz. * @param {String} whatever - some string that has some purpose * @param {Function} callback - a function that needs to be run * @returns {Boolean} whether or not something happened */ function something(whatever, callback) { ...
Как документировать строковый тип в jsdoc с ограниченными возможными значениями
у меня есть функция, которая принимает один строковый параметр. Этот параметр может иметь только одно из нескольких определенных возможных значений. Каков наилучший способ документировать то же самое? Должен ли shapeType быть определен как enum или TypeDef или что-то еще? Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"... this.type = shapeType; }; Shape.prototype.getType = function (shapeType) { // shapeType can be "rect", "circle" ...