3 ms·

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 u

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.

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