Javascript.RU

Создать новую тему Ответ
 
Опции темы Искать в теме
  #1 (permalink)  
Старый 04.09.2009, 17:45
Отправить личное сообщение для Octane Посмотреть профиль Найти все сообщения от Octane  
Регистрация: 09.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 и писать просто комментарии?
Ответить с цитированием
  #2 (permalink)  
Старый 04.09.2009, 17:52
Новичок на форуме
Отправить личное сообщение для Kolyaj Посмотреть профиль Найти все сообщения от Kolyaj
 
Регистрация: 19.02.2008
Сообщений: 9,177

А писать @return {String/Boolean} нельзя? Если нет, то взять ext-doc (на базе ExtJS), там можно, и документация симпатичней получается.
Ответить с цитированием
  #3 (permalink)  
Старый 04.09.2009, 18:01
Отправить личное сообщение для Octane Посмотреть профиль Найти все сообщения от Octane  
Регистрация: 09.07.2008
Сообщений: 3,873

Вроде нельзя. Спасибо, посмотрю ext-doc.
Ответить с цитированием
  #4 (permalink)  
Старый 04.09.2009, 19:24
Профессор
Отправить личное сообщение для Dmitry A. Soshnikov Посмотреть профиль Найти все сообщения от Dmitry A. Soshnikov
 
Регистрация: 25.02.2008
Сообщений: 707

По-моему, в подобных докерах есть тип {Variant} или что-то вроде.
__________________
Тонкости ECMAScript
Ответить с цитированием
Ответ



Опции темы Искать в теме
Искать в теме:

Расширенный поиск


Похожие темы
Тема Автор Раздел Ответов Последнее сообщение
Помогите с javascript andruhin Общие вопросы Javascript 12 04.05.2012 09:05
Собрался силами, собираюсь освоить Javascript walker Общие вопросы Javascript 14 20.03.2012 14:17
Программист на JavaScript (удалённо) Vadym Работа 1 28.01.2009 12:57
Компании Яндекс нужен Javascript гуру Yandex Работа 17 16.12.2008 15:46
Нужен Старший разработчик JavaScript Yandex Работа 17 19.08.2008 15:43