neogen VS tsdoc

For any Neovim users, I highly recommend danymat/neogen. It's fast, works with Neovim's treesitter integration, and is written with Lua so scripting and extending it is pretty easy. Python support in particular is great.

I use LunarVim (I hope it isn't a problem) and TSInsalled clangd, I also added Neogen plugin

There is neogen for generating the boilerplate automatically for not just Lua but also other languages with this kind of integration like Javascript (jsdocs)

Neogen might be what you want. But also note that some language servers help via auto completion when you start writing a doc comment, e.g. Scala metals will insert the function parameters in to the comment for you

PS: I use neogen.

I think you mean https://github.com/danymat/neogen/

Well, I jsdoc and similar types of comments have a lot of things to consider so I suggest you to use a separate plugin: https://github.com/danymat/neogen

neogen: Use treesitter parser to generate annotation, and use extmark for placeholders to jump.

For what it’s worth, there’s also TSDoc[1] which is TypeScript’s sorta-equivalent spiritual successor, and notably uses the same format as JSDoc. Inline type annotation is great—and I vastly prefer it to JSDoc as a type annotation mechanism—but supporting the breadth of documentation capability in an inline code position would probably be unwieldy no matter how you try to accommodate it.

1: https://tsdoc.org/

Docs? TSdoc + TypeDoc or DocFX. Of particular interest, this can be used to generate JSON schema's, useful for REST / GraphQL

Nope, they look the same, at a glance, but they're not the same. JSDoc and TSDoc are different standards, developed by different teams.

JSDoc is a terrible standard. I would rather go for TypeScript + TSDoc, then use TypDoc to generate the actual documentation based on TS typings. Alternatively, you can go for Vue Styleguidist. It's an excellent tool, but, opposite to TSDoc it's not a standard, it's just a tool.

I am trying to use the @microsoft/tsdoc package to generate documentation for a given file. I followed the demo that hey have provided https://github.com/microsoft/tsdoc/tree/main/api-demo and it works for the sample input they provided, shown below.

Maybe this is of interest? https://tsdoc.org/

Awesome, thank you! Would you be willing to support TSDoc ?