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

Gozar 30.12.2011 14:11

Цитата:

Сообщение от Octane (Сообщение 147338)
@cfg, как в ext doc, нету?

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

/**
  * @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}, поэтому раньше не заметил.

FINoM 31.12.2011 03:26

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

FINoM 31.12.2011 03:29

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

melky 31.12.2011 12:00

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

Riim 01.01.2012 18:57

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

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

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

monolithed 01.01.2012 20:41

Цитата:

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

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

@param {object} Arguments Object ...


хотя нет.. ;)

Octane 16.01.2012 13:30

А реально расписать вот такое безобразие:
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 у функций был заполнен. И вообще стоит ли с этим заморачиваться? :)


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