A
A
Alexander2021-02-02 12:07:33
API
Alexander, 2021-02-02 12:07:33

JSDoc documentation generation with conveniences?

Perhaps this can be configured in jsdoc, or third-party documentation generation libraries (from jsdoc) can be solved.
Actually two problems.
1. jsDoc in VS Code supports syntax highlighting when I describe a parameter through destructuring , but the jsDoc documentation generator does not, it displays as an Object, you have to write 10 lines to describe the structure incomeObject.params, incomeObject.params.field, etc... (besides it doesn't support [], only Array<>)

* @param { {params:{ field:Array<{name:string, type:CustomType.name}>, entity:Entity }} } incomeObject описание

2. Does not support the description of the parameter as a property of objects of custom types .
CustomType works, and displays and links, CustomType.name - doesn't work, doesn't highlight and doesn't link (and doesn't embed property description, for example)

Answer the question

In order to leave comments, you need to log in

1 answer(s)
A
Anton Shamanov, 2021-02-02
@SilenceOfWinter

https://jsdoc.app/about-plugins.html plugin write or google ready

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question