Creating documentation from TypeScript code via TypeDoc
Posted: (EET/GMT+2)
Now that TypeScript is getting wider use, I find myself replacing plain JavaScript code with TypeScript, if possible. This leads to the question on how to document your code (you are writing code comments at least, aren't you?), because some argue that TypeScript code, along with type definitions and annotations in place, is already sufficient.
While I disagree on this, it is always good to know what is available in the field. For TypeScript, I'm currently using JSDoc like code comments in many places, and to generate documentation automatically from this, you could use a tool like TypeDoc for this.
TypeDoc outputs a HTML document that is always up-to-date, because it is built from the source code. For more information, the project’s web site at www.typedoc.org.
Hope this helps!