jsdoc

1зной

1ответ

Как сгенерировать HTML для JSDoc

Я хотел бы создать файл для создания файла JSDoc для создания структуры, которую я создаю, но не могу найти способ вывода документации. Можно ли выводить документ в JSON или HTML? Или мне придется соз

javascript documentation-generation jsdoc 2016-02-03

---

0зной

1ответ

Как отделить документ API до внутренних функций doc в JSDOC

У меня есть два файла .js, которые представляют один модуль. Этот модуль будет представлять собой API, который будет использоваться с другими модулями, поэтому я хочу хорошо документировать этот API.

javascript node.js jsdoc jsdoc3 2016-02-07

---

1зной

1ответ

Как получить ссылку на индексную страницу для отображения

Я начал использовать jsdoc с jaguarjs-jsdoc для создания документации для моего API с помощью узла. Он работает достаточно хорошо, и я могу даже использовать файл readme.md для создания индексной стра

javascript jsdoc jsdoc3 2016-02-10

---

3зной

2ответ

Как записать пространство по умолчанию в свойствах jsdoc

Я не могу найти способ распечатать пространство при регистрации значений свойств по умолчанию в JSDOC. Пример: /** * @prop {string} str='String with space' - The string. */ Это будет документирован та

javascript jsdoc jsdoc3 2016-02-11

---

0зной

1ответ

Должен ли я документировать «обратный обратный вызов()» в качестве возвращаемого значения, если он не предназначен для использования?

У меня есть кусок кода, который не возвращает ничего полезного: /** * Close the web server * * @param {function} callback - Called after web server is stopped */ PolyApp.prototype.stop = function

jsdoc 2016-02-11

---

0зной

1ответ

Тип JSDoc для «окна»?

Мне любопытно, какое определение типа я должен использовать для передачи окна в функцию. Обычно я использую HTMLElement, но я не думаю, что это окно HTMLElement Спасибо!

javascript jsdoc 2016-02-11

---

1зной

1ответ

Пример кода рендеринга Markdown с String (JSDoc2MD)

Я использую комментарии JSDoc в JS-файле и запускаю JSDoc2MD для рендеринга этих комментариев в файл readme.md. Я хочу включить примеры кода в свою документацию, используя @example tag из JSDoc. У мен

markdown jsdoc jsdoc2md 2016-02-12

---

0зной

1ответ

JSDoc, документирующие функции, хранящиеся внутри объекта

У меня возникли проблемы с получением функций для показа в JSDoc, когда они хранятся внутри объекта. Итак, у меня есть что-то вроде: /** */ var methods = {}; /** Get all resources */ methods.ge

javascript jsdoc 2016-02-14

---