tsdoc
A doc comment standard for TypeScript (by microsoft)
vim-doge
(Do)cumentation (Ge)nerator for nearly 20 languages 📚 Generate proper code documentation with a single keypress. ⚡️🔥 (by kkoomen)
Our great sponsors
| tsdoc | vim-doge | |
|---|---|---|
| 15 | 12 | |
| 4,655 | 961 | |
| 1.1% | - | |
| 6.1 | 8.9 | |
| 19 days ago | about 1 month ago | |
| TypeScript | Rust | |
| 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?
vim-doge
Posts with mentions or reviews of vim-doge.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2022-11-05.
-
vim-doge v4: The Rust Rewrite
I’m the creator of the vim plugin called vim-doge and I like to share some awesome benchmark results with the new version that has been written in Rust.
-
Python LSP setups for productive coding
Don't get me started on how every compelling docstring generator seems to be some vendor-locked plugin: (DoxyDoxygen, vim-doge, autoDocstring)
-
How do y'all add jsdoc-like comments in neovim?
Something like this? https://github.com/kkoomen/vim-doge
-
Python Docstring Plugin Recommendations.
https://github.com/kkoomen/vim-doge is great generator for nearly any language
-
Neogen - The annotation toolkit you never knew you needed
I'm not sure I understand what the plug-in does. Is it similar to vim-doge for generating documentation?
-
Which VIM settings do you use for writing jsdoc comments?
This does not really find a solution to indentation, but this post shows vim-doge which help generating jsdoc (and others). Maybe you could take a look and find this useful.
- jsdoc for neovim 0.5
-
Any plugins for auto-generating docs out there?
vim-doge
- Any good plugin for (python) docstrings?
-
Python Docstring Plugin Recommendations
I can recommend vim-doge; it works great for me and supports a variety of Python docstring formatting standards.
What are some alternatives?
When comparing tsdoc and vim-doge you can also consider the following projects:
typedoc - Documentation generator for TypeScript projects.
nvim-tree-docs - Code documentation built with treesitter
vscode-docthis - JSDoc generator extension for Visual Studio Code.
neogen - A better annotation generator. Supports multiple languages and annotation conventions.
compodoc - :notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application
vim-vue-plugin - Vim syntax and indent plugin for .vue files
redoc - 📘 OpenAPI/Swagger-generated API Reference Documentation
coc-vetur - Vue language server extension for coc.nvim
tree-sitter-comment - Tree-sitter grammar for comment tags like TODO, FIXME(user).
vim-closetag - Auto close (X)HTML tags
ts-morph - TypeScript Compiler API wrapper for static analysis and programmatic code changes.
vim-signify - :heavy_plus_sign: Show a diff using Vim its sign column.