Показать сообщение отдельно
  #1 (permalink)  
Старый 01.06.2012, 15:24
Аватар для Раед
''
Отправить личное сообщение для Раед Посмотреть профиль Найти все сообщения от Раед
 
Регистрация: 11.12.2011
Сообщений: 636

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

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

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

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

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