Имеется ли документация по подмножеству, надмножеству или сочетанию этих двух JSDoc? IntelliJ поддерживает? Моя мотивация использования JSDoc двояка:
Для # 1 выше для меня важно использовать разметку JSDoc, которая поддерживается IntelliJ, и до сих пор выяснение этого в основном было процессом проб и ошибок.
Основываясь на той небольшой информации, которая доступна в документации WebStorm, похоже, что IntelliJ IDEA поддерживает весь набор JSDoc. Единственное другое примечание в документации касается просмотра встроенной документации. который указывает только на страницу JSDoc SourceForge.
Это было немного проб и ошибок, но я, наконец, смог получить приличные результаты с ним. У меня были особые проблемы с наследованием для Backbone, похожего на OO, чтобы оно работало правильно. В итоге я сделал следующее:
/**
* @class App.Views.ProductView
* @extends App.Views.TemplateView
**/
App.Views.ProductView = App.Views.TemplateView.extend(
/** @lends App.Views.ProductView **/
{
/**
* @param {string} str
* @return string[]
**/
method: function (str) {
return [str, str];
}
};
Вам определенно придется много помогать вручную, когда речь идет о наследовании.
Насколько я могу судить, расхождения заключались в следующем: вы должны указать имя для @class, иначе он запутается. @name, похоже, работает не очень хорошо. Остальное прилично, некоторые теги не используются (@event и т.д...).
Поддержка JSDoc в IDEA / WebStorm в настоящее время является стандартной функцией, но с некоторой настройкой IDE можно создать JSDoc одним щелчком мыши.
Пошаговое руководство по включению генерации JSDoc в IDEA/WebStorm с модулем jsdoc npm: Как создать документацию JSDoc в IntelliJ IDEA / WebStorm?
