tsdoc VS tree-sitter-comment

TSDoc Parser

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 ?

As far as I know there is currently no treesitter parser for Doxygen style comments. There is a language agnostic comment parser that is supported by nvim-treesitter that will highlight things like TODO: and NOTE: in comments. Until this recent commit nvim-treesitter provided a query for this parser that highlighted @ text in comments. It was meant to highlight a reference to a user but it doubled as a doxygen tag highlight for me for a while. I just noticed that this query has been removed and I'm not sure why but you can add it as a custom query in your Neovim config. I have yet to try this so you'll have to refer to the Neovim treesitter docs for where to add the query.

I'm not sure how to use this in Emacs, but there's also a tree-sitter grammar specifically for comment blocks, including TODOs: https://github.com/stsewd/tree-sitter-comment

you mean this one? https://github.com/stsewd/tree-sitter-comment

The reason I implemented this is because of the slow performance of tree-sitter-comment in large files. Treesitter will inject the comment language for every line comment, which is far from ideal. I've disabled the comment parser, but still wanted to see @something highlighted in Lua comments.

The right most window shows the code I want to query. This is a .cpp file, so the main-language is C++. For highlighting the two comments, I'm using tree-sitter-comment. This plugin injects the comment-language. I want to query all tag nodes from this injected language, but this query does not work.

You can install this parser for treesitter which highlights comments :)