Показать сообщение отдельно
  #1 (permalink)  
Старый 04.09.2009, 18:45
Отправить личное сообщение для Octane Посмотреть профиль Найти все сообщения от Octane  
Регистрация: 10.07.2008
Сообщений: 3,873

JSDoc — JavaScript Documentation Tool
Приходилось использовать такой способ комментирования (документирования) JavaScript-кода в коммерческом проекте. На вопрос: "Как описать метод, возвращающий или принимающий разные значения?", ведущий программист отвечал: "Так делать не нужно, получится не поддерживаемый код". Приходилось так не делать, проблем с JSDoc не возникало
Но все же, как быть если нужно описать метод, возвращающий и принимающий разные значения?

Например, такой метод:
F.prototype = {
	/**
	 *
	 */
	css: function(arg, val) {
		if(typeof arg == "string") {
			if(typeof val == "undefined") {
				return this.getCompudetStyle(arg);
			}
			this.setStyle(arg, val);
		} else {
			for(var prop in arg) {
				this.setStyle(prop, arg[prop]);
			}
		}
		return this;
	}
};


Или вообще забить на этот JSDoc и писать просто комментарии?
Ответить с цитированием