@sergey_zhuravlev_89

Как расширить функциональность тега example в JSDoc?

Приветствую вас, товарищи.
Пишу документацию, по мере разработки, к коду и нахожу неудобным тег (с)example т.к. туда можно записывать только код JS. А мне нужно, чтобы как в angular можно было, а именно:

/**
@example
Тут я могу писать разного рода описание к коду ниже
```js
// Тут код JS
```
Тут снова описание, а ниже, к примеру, код HTML
```html
<!-- Код HTML тут -->
```
*/


В JSDoc так нельзя. Можно ли какой либо плагин поставить или ещё что-то в этом роде, чтобы так можно было? И желательно, чтобы такого рода примеры можно было и в описание вставлять (c)description и в описание к (c)param.
И известны ли кому либо какие нибудь читабельные темы оформления? А то документация какая то не читабельная. Разные темы пробовал ставить, но одна "лучше" другой!
  • Вопрос задан
  • 42 просмотра
Пригласить эксперта
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы