Блог

Каким был бы способ документировать веб-компонент с помощью jsdoc3

Вот пример веб-компонента, зарегистрированного с помощью x-tag.

 xtag.register('x-analytics',
{
    lifecycle : {
        created : function(){
        }
    },
    accessors : {
        code : {
            attribute : true
        },
        domain : {
            attribute : true
        }
    }
});
  

Поскольку X-Tag — это тоже просто JavaScript, вы можете просто использовать соответствующие аннотации, предоставляемые jsdoc. Итак, такие вещи, как @memberof и т.д.

Однако синтаксис веб-компонентов может иметь свой собственный дополнительный смысл. Например, вам, вероятно, нужна аннотация для @element или @lifecycleCallback и тому подобное. Это не предусмотрено jsdoc, и поэтому, например, Polymer использует собственную аннотацию документации с помощью core-component-page .

Вы либо используете то, что предоставляет jsdoc, и смотрите, какие аннотации лучше всего подходят для вашего варианта использования, либо используете что-то вроде dgeni, которое позволяет вам создавать канал инструментов документации полностью с нуля, так что у вас есть полный контроль над вашими аннотациями и т.д.