Menu
Is there any tool for Typescript to auto-generate documentation from annotated comments?
I tried using JSDoc with TypeScript. It works upto some extent but they just are not meant to work together.
Any ideas/suggestions?
724
Compatible with JavaScript and TypeScriptJsDoc is works seamlessly with both JavaScript and TypeScript. The types declared via JsDoc serve as a form of API documentation for your code. JsDoc can also be paired with TypeScript, making your code as descriptive as possible.
Conclusion. JSDoc makes coding in JavaScript easier, helping us to code quickly while avoiding obvious errors, just by adding some lines of optional comments in our code.
What is TSDoc? TSDoc is a proposal to standardize the doc comments used in TypeScript code, so that different tools can extract content without getting confused by each other's markup. The TSDoc notation looks pretty familiar: export class Statistics { /** * Returns the average of two numbers.
Or alternatively, somebody created this which might work for you http://functorial.com/typescript-docs/
78
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
