Недавно я начал использовать комментарии jsdoc для документирования нашего кода javascript, однако я нахожу противоречивые примеры использования тега @param.
См. https://code.google.com/p/jsdoc-toolkit/wiki/TagParam (PascalCase)
и https://developers.google.com/closure/compiler/docs/js-for-compiler (верблюд/нижний регистр).
camelCase имеет смысл для меня, так как:
var foo = 1;
console.log(typeof foo); // outputs "number"
Какая правильная оболочка используется для комментариев jsDoc @param? Или это не имеет значения? Я планирую использовать его для генерации документов, а также для запуска кода через закрытие Google, чтобы получить проверку типов.
Спасибо!
В конфликтующих примерах для выражений типа JSDoc используются примитивные типы JavaScript string, number и boolean, которые имеют соответствующие типы-оболочки: string, number и boolean.
От Закрытие: окончательное руководство:
Использование типов обертки запрещено в Closure Library, так как некоторые функции могут не работать корректно, если используются типы обертки где ожидаются примитивные типы.
См. MDN: Различие между примитивами строк и объектами String.