Javascript.RU

Создать новую тему Ответ
 
Опции темы Искать в теме
  #1 (permalink)  
Старый 29.12.2011, 13:30
Профессор
Посмотреть профиль Найти все сообщения от Livaanderiamarum
 
Регистрация: 25.12.2011
Сообщений: 786

Используете ли вы JSDoc ?
JSDoc это генератор документации. Часто встречал его в кодах известных библиотек. Но лишь недавно узнал что в некоторых редакторах он влияет на авто дополнение кода. Я думаю если создавать что-то серьезное, даже для себя, то обязательно должна быть документация. Потому что через неделю ты помнишь как работает код, а через месяц уже не помнишь. Раньше я делал обычными комментариями. Щас подумал что лучше юзать JSDoc. Что думаете об этом?

http://www.artlebedev.ru/tools/techn...eclipse-spket/

а вот объяснение тегов на русском

http://vingrad.ru/blogs/Alix/files/2...discussion.pdf
Ответить с цитированием
  #2 (permalink)  
Старый 29.12.2011, 23:58
Аватар для Gvozd
Матрос
Отправить личное сообщение для Gvozd Посмотреть профиль Найти все сообщения от Gvozd
 
Регистрация: 04.04.2008
Сообщений: 6,246

С недавних пор - использую.
Ранее использовал только PHPDoc
За ссылки спасибо
Ответить с цитированием
  #3 (permalink)  
Старый 30.12.2011, 00:30
sinistral
Посмотреть профиль Найти все сообщения от melky
 
Регистрация: 28.03.2011
Сообщений: 5,418

сейчас начал использовать. классная штука. до этого я пытался сделать то же самое, но через комментарии (не знал, что существует JSDoc)
Ответить с цитированием
  #4 (permalink)  
Старый 30.12.2011, 00:40
Профессор
Посмотреть профиль Найти все сообщения от Livaanderiamarum
 
Регистрация: 25.12.2011
Сообщений: 786

Сообщение от melky Посмотреть сообщение
до этого я пытался сделать то же самое, но через комментарии (не знал, что существует JSDoc)
ой как знакомо))
Ответить с цитированием
  #5 (permalink)  
Старый 30.12.2011, 02:12
Аватар для trikadin
Модератор
Отправить личное сообщение для trikadin Посмотреть профиль Найти все сообщения от trikadin
 
Регистрация: 27.04.2010
Сообщений: 3,417

Сообщение от melky
сейчас начал использовать. классная штука. до этого я пытался сделать то же самое, но через комментарии (не знал, что существует JSDoc)
Да-да, плюс один) У меня была система xml-комментирования)

Livaanderiamarum, теперь буду пользоваться этим..)
__________________
Читайте:
Ты любопытный) Всё-таки, ничему в этом мире не помешает хорошая доля юмора)
Как спросить, чтобы вам ответили
Часто Задаваемые Вопросы (FAQ)
Ответить с цитированием
  #6 (permalink)  
Старый 30.12.2011, 02:16
Аватар для Nekromancer
Профессор
Отправить личное сообщение для Nekromancer Посмотреть профиль Найти все сообщения от Nekromancer
 
Регистрация: 06.05.2009
Сообщений: 1,163

Да, таки клёво, в WebStorm тоже вроде работает
__________________
Нужно равняться на лучших, а не оправдываться за счёт худших.
Ответить с цитированием
  #7 (permalink)  
Старый 30.12.2011, 03:23
Аватар для trikadin
Модератор
Отправить личное сообщение для trikadin Посмотреть профиль Найти все сообщения от trikadin
 
Регистрация: 27.04.2010
Сообщений: 3,417

Кстати, имхо, куда более клёвая документация - вот здесь:
http://code.google.com/p/jsdoc-toolkit/wiki/

Кстати, а у разрабов браузеров нет желания использовать JSDoc в целях ускорения кода? Например, смотреть типы переменных по ним...
__________________
Читайте:
Ты любопытный) Всё-таки, ничему в этом мире не помешает хорошая доля юмора)
Как спросить, чтобы вам ответили
Часто Задаваемые Вопросы (FAQ)

Последний раз редактировалось trikadin, 30.12.2011 в 03:27.
Ответить с цитированием
  #8 (permalink)  
Старый 30.12.2011, 07:20
что-то знаю
Отправить личное сообщение для devote Посмотреть профиль Найти все сообщения от devote
 
Регистрация: 24.05.2009
Сообщений: 5,176

чето не очень, элементарно вбил ему тип CSSStyleDeclaration, показывает старые свойства CSS тоесть вместо borderRadius, показывает MozBorderRadius и т.д. Очень старая дока у них вбита.
Ответить с цитированием
  #9 (permalink)  
Старый 30.12.2011, 08:07
Аватар для Gozar
Отправить личное сообщение для Gozar Посмотреть профиль Найти все сообщения от Gozar
 
Регистрация: 07.06.2007
Сообщений: 7,504

Использую где-то около года.

Кто как расписывает аргументы в виде объекта?

Я делаю так:

/**
* @param {Object} o
* @param {String} o.title
*/
function (o) {

}
__________________
Последний раз редактировалось Gozar, Сегодня в 24:14.
Ответить с цитированием
  #10 (permalink)  
Старый 30.12.2011, 09:19
sinistral
Посмотреть профиль Найти все сообщения от melky
 
Регистрация: 28.03.2011
Сообщений: 5,418

Gozar, а как ещё ?

Сообщение от devote Посмотреть сообщение
чето не очень, элементарно вбил ему тип CSSStyleDeclaration, показывает старые свойства CSS тоесть вместо borderRadius, показывает MozBorderRadius и т.д. Очень старая дока у них вбита.
HTMLStyleSheet вообще ничего не выдаёт
Ответить с цитированием
Ответ



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

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


Похожие темы
Тема Автор Раздел Ответов Последнее сообщение
Используете ли вы методики разработки? Андрей Параничев Оффтопик 12 27.02.2017 12:03
JSDoc — JavaScript Documentation Tool Octane Оффтопик 3 04.09.2009 20:24
какую шаблонизацию вы используете для? tenshi Общие вопросы Javascript 0 01.05.2008 12:46