Допустимые типы параметров jsdoc

Есть ли где-нибудь список допустимых типов тегов param для jsdoc? Например,

@param {type} myParam Some parameter description

Я знаю, что такие вещи, как number а также String допустимы, но что, если я хочу документально подтвердить, что число является целым числом. Является int действует?

Я немного погуглил, но не могу найти полный список.

Источник

3 ответа

Решение

Инструмент JS Documentation, который я использовал, в любом случае просто разбивает комментарии на строки, позволяя помещать все, что вы хотите, в раздел {type}.

Вы можете придерживаться типов JavaScript, если хотите, например, {Number}, или если вы хотите указать, вы можете сделать {integer} ... Я бы порекомендовал что-то вроде:

@param {Number} myParam must be an integer

ура

Источник

Ответить на актуальный вопрос

Есть ли где-нибудь список допустимых типов тегов param для jsdoc?

Документация @param здесь говорится, что вы можете использовать встроенные типы и " namepaths" (например, пути к типам, которые вы создали / документировали ранее, и ваши собственные типы, которые вы объявили с помощью @type,

Если вы посмотрите вверх built-in Javascript types, вы получите следующее, например, здесь вы получите список типов примитивов:

  • логический
  • Ноль
  • Неопределенный
  • Число
  • строка
  • Символ (новый в ECMAScript 2015)
  • объект

И вот несколько примеров именных путей:

  • exampleFunction
  • ExampleClass # someInstanceMember
  • exampleClass.staticMember
  • ExampleClass ~ innerMember

Например @param {exampleClass} exampleParam Instance of your example class

Источник

Я провел поиск в большой кодовой базе. Вот некоторые из наиболее распространенных, которые я нашел:

  • примитивы
    • любой
    • логическое значение
    • нулевой
    • число
    • нить
  • общие объекты
    • Множество
    • Документ
    • Элемент
    • Функция
    • HTML-документ
    • HTMLЭлемент
    • jQuery
    • Объект
    • Окно
Источник
Другие вопросы по тегам