Javascript-форум (https://javascript.ru/forum/)
-   Общие вопросы Javascript (https://javascript.ru/forum/misc/)
-   -   JSDoc - помогите разобраться (https://javascript.ru/forum/misc/28754-jsdoc-pomogite-razobratsya.html)

Раед 01.06.2012 15:24

JSDoc - помогите разобраться
 
Введение
Пишу для себя фреймворк. Решил прокомментировать его JSDoc'ом, так как уже начал путаться во всех этих функциях.

Единственный генератор документации, который я нашёл - JSDoc Toolkit.
Проблема 1
Он калечит русские символы, превращая их в вопросики (ну так они выглядят в FF)
Помогло перекодирование файла в UTF-8, но хотелось бы узнать, есть ли ещё варианты. Если нет, то подскажите какой-нибудь ещё генератор документации, который нормально работает с русским текстом.

Проблема 2
Структура файла примерно такая: вверху дополнительные либы (не мои), они сжаты и прокомментированы одним тегом @author (подвопрос 2.1: на какой кусок кода будет распространяться этот тег; подвопрос 2.2: эти либы нужны для кроссбраузерности, как исключить их из документирования?).
Дальше идёт мой код.
Он обвёрнут в (function(){}()). Там объявляется локальная переменная $m, которая в конце вставляется в глобальную область (window.$m = $m).
Так вот JSDoc никак не хочет её документировать.
Вопрос: какие теги нужно указать при объявлении этой переменной?

Проблема 3
Согласно документации, фреймворк объявляет кучу переменных в глобальной области, однако консоль это не подтверждает.
Вопрос: в чём проблема?

__________________________________________________ ________________
Пока всё, но возможно со временем тут ещё будут публиковаться вопросы.

nerv_ 01.06.2012 16:43

Цитата:

Сообщение от Раед
Он калечит русские символы

кодировку поменять не пробовал?)

C JSDocs дело иметь не приходилось, поэтому за темой буду следить с интересом :)

melky 01.06.2012 18:16

Цитата:

Сообщение от Раед
2.2: эти либы нужны для кроссбраузерности, как исключить их из документирования?).

http://code.google.com/p/jsdoc-toolkit/wiki/TagIgnore

Цитата:

Сообщение от Раед
Он обвёрнут в (function(){}()). Там объявляется локальная переменная $m, которая в конце вставляется в глобальную область (window.$m = $m).
Так вот JSDoc никак не хочет её документировать.
Вопрос: какие теги нужно указать при объявлении этой переменной?

http://code.google.com/p/jsdoc-toolkit/wiki/TagExports

на остальные вопросы - хз. но там есть папка документации. я так JSDoc изучал

Раед 01.06.2012 21:25

Цитата:

Сообщение от nerv_
кодировку поменять не пробовал?)

Кодировку чего? Если файла, то
Цитата:

Сообщение от Раед
Помогло перекодирование файла в UTF-8, но хотелось бы узнать, есть ли ещё варианты.

. .

. .

Цитата:

Сообщение от melky
http://code.google.com/p/jsdoc-toolkit/wiki/TagIgnore

Если я правильно понял, он только на 1 переменную (объект, функцию) действует, а мне нужно исключить из документирования целый кусок кода.

melky 01.06.2012 23:12

Цитата:

Сообщение от Раед
Если я правильно понял, он только на 1 переменную (объект, функцию) действует, а мне нужно исключить из документирования целый кусок кода.

Думаете, что неверным поступком будет повтор тега по всему коду? Но ведь @param ведь повторяется в каждой функции, и ничего.

Раед 02.06.2012 18:18

Цитата:

Сообщение от melky
Думаете, что неверным поступком будет повтор тега по всему коду?

То есть нет способа просто исключить кусок кода из документирования?

melky 02.06.2012 18:52

Цитата:

Сообщение от Раед (Сообщение 178273)
То есть нет способа просто исключить кусок кода из документирования?

Я на это не намекал. Я не знаю :).

Раед 02.06.2012 21:36

Цитата:

Сообщение от Раед
Согласно документации, фреймворк объявляет кучу переменных в глобальной области, однако консоль это не подтверждает.

Понял. Он суёт часть локальных переменных в глобальную область. Есть идеи, как исправить?


Часовой пояс GMT +3, время: 10:09.