JSDoc VS TypeDoc

JSDoc Reviews

TypeDoc Reviews

JSDoc mentions (47)

• Add typing to your Javascript code (without Typescript, kinda) ✍🏼

  The best way to do this, of course, is with JSDoc. But something I always found awkward about jsdoc is defining the object types in the same file. So, after a lot of reading, I found a way to combine JSDoc with declaration type files from Typescript. Let me give you an example:. - Source: dev.to / 10 days ago

• What is JSDoc and why you may not need typescript for your next project?

  There is a lot of specific symbols presented on the JSDOC specification that can be found here: https://jsdoc.app. - Source: dev.to / about 1 month ago

• TypeScript Might Not Be Your God: Case Study of Migration from TS to JSDoc

  JSDoc is a specification for the comment format in JavaScript. This specification allows developers to describe the structure of their code, data types, function parameters, and much more using special comments. These comments can then be transformed into documentation using appropriate tools. - Source: dev.to / about 1 month ago

• Adding a search feature to my app

  Working with new features, frameworks, and tools, the experience of reading documentation is a critical part of it. I have been lucky to work with projects that feature really easy to read documentation such as USWDS and Bun, but I've also had the misfortune to work with pretty terrible documentation like JSDoc. The JSDoc documentation lacks a search field which makes searching for specific items an ordeal and... - Source: dev.to / 4 months ago

• JavaScript First, Then TypeScript

  The Svelte team followed suit but motivated by the maintainer's developer experience as they migrated the project away from TypeScript in favor of plain JSDoc comments for type annotations instead. - Source: dev.to / 5 months ago

TypeDoc mentions (13)

• Mastering JSDoc: the complete guide for Javascript developers

  Finally, JSDoc can be used to generate documentation for your code using tools like JSDoc itself and TypeDoc. These tools generate HTML or Markdown documentation based on your JSDoc annotations, making it easier for others to understand how your code works and how to use it. - Source: dev.to / 10 months ago

• Opinionated standards for JSDoc

  Since you're using TypeScript, use TypeDoc. Source: 11 months ago

• I created a game engine using TypeScript. Please roast it.

  I was thinking of using something like https://typedoc.org to do it, do you have experience with this sort of tools? Source: about 1 year ago

• 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. Source: over 1 year ago

• Ask r/webdev: Documentation Methodology & Tools?

  API docs can be generated from docblocks the format of which will depend on the language in question e.g. TS = TypeDoc (parses TSdoc). Source: over 1 year ago