ESDoc с TypeScript: как использовать блоки комментариев?
Я использую ESDoc для создания документации для проекта JS. Это работает хорошо!
Теперь я хочу перенести этот JS-проект в TS-проект. Что касается документации, я видел этот плагин, который помогает ESDoc обрабатывать TypeScript.
Это виды работы. Просто используя плагин, документ создается, как и раньше, как показано ниже:
/**
* @desc Stringify a number
* @param {number} nbr Number to stringify.
* @return {string} The stringified number.
* @example const str = stringify(42);
*/
stringify(nbr: number): string {
return `${nbr}`;
}
Мне немного неудобно определять типы с помощью TypeScript и внутри блока комментариев. Итак, как сказано в документации, я удалил эти типы из комментариев:
/**
* @desc Stringify a number
* @param nbr Number to stringify.
* @return The stringified number.
* @example const str = stringify(42);
*/
stringify(nbr: number): string {
return `${nbr}`;
}
Но из-за этого сгенерированная документация потеряла типы. Типы TypeScript не учитываются:
Забавно, если я уберу тег @desc
(и только тег, а не соответствующий текст), как показано ниже, результаты также разные:
/**
* Stringify a number
* @param nbr Number to stringify.
* @return The stringified number.
* @example const str = stringify(42);
*/
stringify(nbr: number): string {
return `${nbr}`;
}
На этот раз учитываются типы TypeScript, но я проиграл @param
а также @return
описания и даже @example
!
Должен сказать, у меня заканчиваются идеи...
Знаете ли вы, как я могу воспользоваться преимуществами типов TypesScript, не теряя остальную документацию?
Согласно документации esdoc-typescript-plugin, это возможно, но я не могу этого сделать.
Что я делаю неправильно?:)
Заранее спасибо!