29.12.2011, 13:30
|
Профессор
|
|
Регистрация: 25.12.2011
Сообщений: 786
|
|
Используете ли вы JSDoc ?
JSDoc это генератор документации. Часто встречал его в кодах известных библиотек. Но лишь недавно узнал что в некоторых редакторах он влияет на авто дополнение кода. Я думаю если создавать что-то серьезное, даже для себя, то обязательно должна быть документация. Потому что через неделю ты помнишь как работает код, а через месяц уже не помнишь. Раньше я делал обычными комментариями. Щас подумал что лучше юзать JSDoc. Что думаете об этом?
http://www.artlebedev.ru/tools/techn...eclipse-spket/
а вот объяснение тегов на русском
http://vingrad.ru/blogs/Alix/files/2...discussion.pdf
|
|
29.12.2011, 23:58
|
|
Матрос
|
|
Регистрация: 04.04.2008
Сообщений: 6,246
|
|
С недавних пор - использую.
Ранее использовал только PHPDoc
За ссылки спасибо
|
|
30.12.2011, 00:30
|
sinistral
|
|
Регистрация: 28.03.2011
Сообщений: 5,418
|
|
сейчас начал использовать. классная штука. до этого я пытался сделать то же самое, но через комментарии (не знал, что существует JSDoc)
|
|
30.12.2011, 00:40
|
Профессор
|
|
Регистрация: 25.12.2011
Сообщений: 786
|
|
Сообщение от melky
|
до этого я пытался сделать то же самое, но через комментарии (не знал, что существует JSDoc)
|
ой как знакомо))
|
|
30.12.2011, 02:12
|
|
Модератор
|
|
Регистрация: 27.04.2010
Сообщений: 3,417
|
|
Сообщение от melky
|
сейчас начал использовать. классная штука. до этого я пытался сделать то же самое, но через комментарии (не знал, что существует JSDoc)
|
Да-да, плюс один) У меня была система xml-комментирования)
Livaanderiamarum, теперь буду пользоваться этим..)
|
|
30.12.2011, 02:16
|
|
Профессор
|
|
Регистрация: 06.05.2009
Сообщений: 1,163
|
|
Да, таки клёво, в WebStorm тоже вроде работает
__________________
Нужно равняться на лучших, а не оправдываться за счёт худших.
|
|
30.12.2011, 03:23
|
|
Модератор
|
|
Регистрация: 27.04.2010
Сообщений: 3,417
|
|
Кстати, имхо, куда более клёвая документация - вот здесь:
http://code.google.com/p/jsdoc-toolkit/wiki/
Кстати, а у разрабов браузеров нет желания использовать JSDoc в целях ускорения кода? Например, смотреть типы переменных по ним...
Последний раз редактировалось trikadin, 30.12.2011 в 03:27.
|
|
30.12.2011, 07:20
|
что-то знаю
|
|
Регистрация: 24.05.2009
Сообщений: 5,176
|
|
чето не очень, элементарно вбил ему тип CSSStyleDeclaration, показывает старые свойства CSS тоесть вместо borderRadius, показывает MozBorderRadius и т.д. Очень старая дока у них вбита.
|
|
30.12.2011, 08:07
|
|
猫
|
|
Регистрация: 07.06.2007
Сообщений: 7,504
|
|
Использую где-то около года.
Кто как расписывает аргументы в виде объекта?
Я делаю так:
/**
* @param {Object} o
* @param {String} o.title
*/
function (o) {
}
__________________
Последний раз редактировалось Gozar, Сегодня в 24:14.
|
|
30.12.2011, 09:19
|
sinistral
|
|
Регистрация: 28.03.2011
Сообщений: 5,418
|
|
Gozar, а как ещё ?
Сообщение от devote
|
чето не очень, элементарно вбил ему тип CSSStyleDeclaration, показывает старые свойства CSS тоесть вместо borderRadius, показывает MozBorderRadius и т.д. Очень старая дока у них вбита.
|
HTMLStyleSheet вообще ничего не выдаёт
|
|
|
|