Hacker News new | ask | show | jobs
by austincheney 1676 days ago
I am frequently working on ways to document inline with the code using comments and then extract those comments during the build process to keep documentation up to date automatically. The comments are formatted as mark down so that they may be converted from code comments to stand alone mark down documents.

I have also noticed that in VS Code a comment immediately preceding a type or interface declaration written in mark down format becomes formatted markdown in the tooltip where that type is used.

1 comments

Are you talking about Typescript here? If so, could you give an example of how to make this happen? This sounds incredibly useful.
I think you and austincheney might be looking for [TypeDoc](https://typedoc.org/). See my comment here: https://news.ycombinator.com/item?id=29265856