Javascript-форум (https://javascript.ru/forum/)
-   Оффтопик (https://javascript.ru/forum/offtopic/)
-   -   Используете ли вы JSDoc ? (https://javascript.ru/forum/offtopic/24420-ispolzuete-li-vy-jsdoc.html)

Livaanderiamarum 29.12.2011 13:30

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

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

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

http://vingrad.ru/blogs/Alix/files/2...discussion.pdf

Gvozd 29.12.2011 23:58

С недавних пор - использую.
Ранее использовал только PHPDoc
За ссылки спасибо

melky 30.12.2011 00:30

сейчас начал использовать. классная штука. до этого я пытался сделать то же самое, но через комментарии (не знал, что существует JSDoc)

Livaanderiamarum 30.12.2011 00:40

Цитата:

Сообщение от melky (Сообщение 147183)
до этого я пытался сделать то же самое, но через комментарии (не знал, что существует JSDoc)

ой как знакомо))

trikadin 30.12.2011 02:12

Цитата:

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

Да-да, плюс один) У меня была система xml-комментирования)

Livaanderiamarum, теперь буду пользоваться этим..)

Nekromancer 30.12.2011 02:16

Да, таки клёво, в WebStorm тоже вроде работает :)

trikadin 30.12.2011 03:23

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

Кстати, а у разрабов браузеров нет желания использовать JSDoc в целях ускорения кода? Например, смотреть типы переменных по ним...

devote 30.12.2011 07:20

чето не очень, элементарно вбил ему тип CSSStyleDeclaration, показывает старые свойства CSS тоесть вместо borderRadius, показывает MozBorderRadius и т.д. Очень старая дока у них вбита.

Gozar 30.12.2011 08:07

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

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

Я делаю так:

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

}

melky 30.12.2011 09:19

Gozar, а как ещё ?

Цитата:

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

HTMLStyleSheet вообще ничего не выдаёт


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