Используете ли вы JSDoc ?
 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Я делаю так:

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

}

Gozar, а как ещё ?

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

Кому ему?
У кого у них?

Я может быть покажусь не очевидным, но предмет разговора отсутствует, хоть гадалку зови.

Начни разговор с ответа.

WebStorm по Ctrl+Q на переменной/функции показывает её описание/параметры/возвращаемое значение из JSDoc-ов.

var a = {};
/**
 * 
 * @param a
 */
a.g = function (a) {

} 
a.g

Ничего не выводит.

Значит PHPStorm этого ещё не умеет :'(

В PHPStorm чёй-то странное, где-то выводит где-то нет, хм.

Спасибо :)

Пока предположение почему работает не везде - слишком сложный объект:

a

потому как на простых по строению объектах работает нормально.

может стоит обновится :)

@cfg, как в ext doc, нету?

/**
 * @class Car.Radio A simple car radio
 * @namespace Car
 * @extends ElectronicThing
 * @cfg {integer} numberOfButtons The number of buttons on this radio.
 * @cfg {boolean} hasCdPlayer True if the radio has a CD player; otherwise false.
 * @constructor
 * @param {object} configObj 
 * An object containing the required configuration options for this class
 * /
Car.Radio = function(configObj) {
  ...
};

Так некуда выше вроде как.:-E

Нашёл, они расписывают объект как я показал выше. В самом конце страницы пример:

/**
  * @param userInfo Information about the user.
  * @param userInfo.name The name of the user.
  * @param userInfo.email The email of the user.
  */
 function logIn(userInfo) {
        doLogIn(userInfo.name, userInfo.email);
 }

Только тип не указали {Object}, поэтому раньше не заметил.

Подскажите плагин для удобного документирования кода в notepad++. В гугле искал, не нашел, надежда на то, что гугл — лох.

Или может есть отдельная прога для написания документации, а то эти ваши ИДЕ не перевариваю из-за психологической травмы, вызванной Вижуал Сдудией.

наверное, http://code.google.com/p/jsdoc-toolkit/

На работе приучили, недавно стал и для себя использовать.

Как бы в этой штуке расписать ситуацию, когда массив берется из arguments?

var elems = [].slice.call(arguments, 1);

вероятно так:

@param {object} Arguments Object ...

хотя нет.. ;)

А реально расписать вот такое безобразие:

var nameSpace = {};

(function () {

	/**
	 * @constructor
	 * @param {Object} arg
	 */
	function Constructor1(arg) {}
	nameSpace.Constructor1 = Constructor1;

	(function () {
		function method1() {}
		Constructor1.prototype.method1 = method1;
	}());

}());

(function () {

	/**
	 * @constructor
	 */
	function Constructor2() {}
	nameSpace.Constructor2 = Constructor2;

	(function () {
		function method2() {}
		Constructor2.prototype.method2 = method2;
	}());

}());

/**
 * @constructor
 * @param {Object} arg
 */
nameSpace.Constructor3 = function (arg) {};
nameSpace.Constructor3.prototype.method3 = function () {};

чтобы WebStorm нормально структуру отображал?


Такие заморочки, чтобы name у функций был заполнен. И вообще стоит ли с этим заморачиваться? :)