jsdoc3

1зной

1ответ

jsdoc с узлом генерирует пустой index.html

Я использовал следующую команду для генерации html из файла javascript. $> jsdoc --debug jquery.js $> open out/index.html Вывод команды DEBUG: JSDoc 3.3.2 (Sat, 13 Jun 2015 22:20:28 GMT) DEBUG: En

9зной

1ответ

AMD + Backbone + JSDoc3 лучший способ документировать

Я ищу лучший способ документировать свой код, но я ничего не нахожу. У меня есть другие темы, в том числе this, но там все не разрешает мою проблему. У меня есть что-то вроде этого: define([ 'bac

2зной

1ответ

Использование ngdocs с свойствами контроллера в angularJS

Я только начинаю захватывать, используя grunt-ngdocs для моего углового приложения и до сих пор так хорошо. Но теперь я хотел бы документировать некоторые свойства другого документально подтвержденног

3зной

1ответ

ngdocs - как документировать конфигурацию модуля и запустить блок

Я недавно начал использовать ngdocs в своем угловом приложении, и я в тупике о том, как разумно документировать конфигурацию и запуск блока. Я это в настоящее время: /** * @ngdoc overview * @name ap

3зной

1ответ

Использование JsDoc3 для больших приложений, Как сгруппировать модули по разделам/категориям/подмодулям

Я работаю над приложением, которое со временем станет довольно огромным. Я решил использовать JsDoc3 и DocStrap для документирования всех модулей. Модули определяются через require.js, а в некоторых м

3зной

1ответ

Нужны ли имена примитивных типов в верхнем или нижнем регистре?

/** * @param {String} foo * @param {Number} bar */ или /** * @param {string} foo * @param {number} bar */ JSDoc @type документация не является явно об этом. Я всегда заглавными String и Numb

17зной

1ответ

JSDoc надлежащим образом документировать socket.on («событие», функция() {}) и маршруты обработчик

Как документировать API с помощью JSDoc, который следующий вид (один файл) // api.js exports.addSocketEvents = function(socket) { /** * This will do that and ... * @param {Object} dat