tsdoc
A doc comment standard for TypeScript (by microsoft)
neogen
A better annotation generator. Supports multiple languages and annotation conventions. (by danymat)
Our great sponsors
| tsdoc | neogen | |
|---|---|---|
| 15 | 19 | |
| 4,655 | 1,140 | |
| 1.1% | - | |
| 6.1 | 5.3 | |
| 19 days ago | 7 days ago | |
| TypeScript | Lua | |
| MIT License | GNU General Public License v3.0 only |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
tsdoc
Posts with mentions or reviews of tsdoc.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-02-05.
-
Jsdoc Cheatsheet
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/
-
What am I Missing (or Could Benefit From Using) For My Stack?
Docs? TSdoc + TypeDoc or DocFX. Of particular interest, this can be used to generate JSON schema's, useful for REST / GraphQL
-
Complete rewrite of ESLint (GitHub discussion by the creator)
Nope, they look the same, at a glance, but they're not the same. JSDoc and TSDoc are different standards, developed by different teams.
- tsc doesn't convert jsdoc types into real typescript
-
How to properly document components
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.
-
Using @microsoft/tsdoc for documenting functions
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.
-
Is it better to use the JSDoc return type or TypeScript return type?
Maybe this is of interest? https://tsdoc.org/
- TSDoc – Documentation Your TypeScript in Code
-
Neogen - The annotation toolkit you never knew you needed
Awesome, thank you! Would you be willing to support TSDoc ?
- Do you use JSdocs with TypeScript?
neogen
Posts with mentions or reviews of neogen.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-05-22.
-
vim-doge v4: The Rust Rewrite
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.
- What plugin do you use for comment code?
-
LSP [clangd] not showing comment of my class function in C++
I use LunarVim (I hope it isn't a problem) and TSInsalled clangd, I also added Neogen plugin
-
Is this Lua function type comment generated by some tool?
There is neogen for generating the boilerplate automatically for not just Lua but also other languages with this kind of integration like Javascript (jsdocs)
-
Code documentation plugin?
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
-
Luasnips are fun!
PS: I use neogen.
-
Looking for plugin:Treesitter plugin for function description
I think you mean https://github.com/danymat/neogen/
-
luasnip with jsdoc like in the luasnip features video
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
- How do y'all add jsdoc-like comments in neovim?
-
I must be missing something
neogen: Use treesitter parser to generate annotation, and use extmark for placeholders to jump.
What are some alternatives?
When comparing tsdoc and neogen you can also consider the following projects:
typedoc - Documentation generator for TypeScript projects.
vim-doge - (Do)cumentation (Ge)nerator for nearly 20 languages 📚 Generate proper code documentation with a single keypress. ⚡️🔥
vscode-docthis - JSDoc generator extension for Visual Studio Code.
neodev.nvim - 💻 Neovim setup for init.lua and plugin development with full signature help, docs and completion for the nvim lua API.
compodoc - :notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application
nvim-bqf - Better quickfix window in Neovim, polish old quickfix window.
redoc - 📘 OpenAPI/Swagger-generated API Reference Documentation
clipboard-image.nvim - Neovim Lua plugin to paste image from clipboard.
nvim-lightbulb - VSCode 💡 for neovim's built-in LSP.
tree-sitter-comment - Tree-sitter grammar for comment tags like TODO, FIXME(user).
NvChad - Blazing fast Neovim config providing solid defaults and a beautiful UI, enhancing your neovim experience.