Javascript.RU

Создать новую тему Ответ
 
Опции темы Искать в теме
  #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
Согласно документации, фреймворк объявляет кучу переменных в глобальной области, однако консоль это не подтверждает.
Вопрос: в чём проблема?

__________________________________________________ ________________
Пока всё, но возможно со временем тут ещё будут публиковаться вопросы.
Ответить с цитированием
  #2 (permalink)  
Старый 01.06.2012, 16:43
Аватар для nerv_
junior
Отправить личное сообщение для nerv_ Посмотреть профиль Найти все сообщения от nerv_
 
Регистрация: 29.11.2011
Сообщений: 3,924

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

C JSDocs дело иметь не приходилось, поэтому за темой буду следить с интересом
__________________
Чебурашка стал символом олимпийских игр. А чего достиг ты?
Тишина - самый громкий звук
Ответить с цитированием
  #3 (permalink)  
Старый 01.06.2012, 18:16
sinistral
Посмотреть профиль Найти все сообщения от melky
 
Регистрация: 28.03.2011
Сообщений: 5,418

Сообщение от Раед
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 изучал
Ответить с цитированием
  #4 (permalink)  
Старый 01.06.2012, 21:25
Аватар для Раед
''
Отправить личное сообщение для Раед Посмотреть профиль Найти все сообщения от Раед
 
Регистрация: 11.12.2011
Сообщений: 636

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

. .

Сообщение от melky
http://code.google.com/p/jsdoc-toolkit/wiki/TagIgnore
Если я правильно понял, он только на 1 переменную (объект, функцию) действует, а мне нужно исключить из документирования целый кусок кода.
Ответить с цитированием
  #5 (permalink)  
Старый 01.06.2012, 23:12
sinistral
Посмотреть профиль Найти все сообщения от melky
 
Регистрация: 28.03.2011
Сообщений: 5,418

Сообщение от Раед
Если я правильно понял, он только на 1 переменную (объект, функцию) действует, а мне нужно исключить из документирования целый кусок кода.
Думаете, что неверным поступком будет повтор тега по всему коду? Но ведь @param ведь повторяется в каждой функции, и ничего.
Ответить с цитированием
  #6 (permalink)  
Старый 02.06.2012, 18:18
Аватар для Раед
''
Отправить личное сообщение для Раед Посмотреть профиль Найти все сообщения от Раед
 
Регистрация: 11.12.2011
Сообщений: 636

Сообщение от melky
Думаете, что неверным поступком будет повтор тега по всему коду?
То есть нет способа просто исключить кусок кода из документирования?
Ответить с цитированием
  #7 (permalink)  
Старый 02.06.2012, 18:52
sinistral
Посмотреть профиль Найти все сообщения от melky
 
Регистрация: 28.03.2011
Сообщений: 5,418

Сообщение от Раед Посмотреть сообщение
То есть нет способа просто исключить кусок кода из документирования?
Я на это не намекал. Я не знаю .
Ответить с цитированием
  #8 (permalink)  
Старый 02.06.2012, 21:36
Аватар для Раед
''
Отправить личное сообщение для Раед Посмотреть профиль Найти все сообщения от Раед
 
Регистрация: 11.12.2011
Сообщений: 636

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



Опции темы Искать в теме
Искать в теме:

Расширенный поиск


Похожие темы
Тема Автор Раздел Ответов Последнее сообщение
Помогите разобраться с this Nigga2102 Элементы интерфейса 4 04.05.2011 18:28
Помогите разобраться!!! Greendumb Общие вопросы Javascript 8 19.08.2010 14:04
Помогите разобраться с кодом. TheWanderer Общие вопросы Javascript 10 17.04.2010 13:41
Помогите пожалуйста разобраться Kupu4 Ваши сайты и скрипты 0 21.01.2010 10:44
Помогите разобраться с галереей IMAGIN yana_studio Общие вопросы Javascript 4 12.12.2009 17:24