JSDoc Reviews and details

Social recommendations and mentions

• Eloquent JavaScript 4th edition (2024)

  I wholeheartedly agree. At most, I introduce JSDoc[1] to newer developers as standardising how parameters and whatnot are commented at least gets you better documentation and _some_ safety without adding any TS knowledge overhead. [1] https://jsdoc.app/. - Source: Hacker News / about 1 month ago

• 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 / 2 months 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 / 3 months 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 / 3 months 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 / 6 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 / 6 months ago

• No comments. Now what?

  Even more relevant, tools like Javadoc, JSDoc, Doxygen, etc. Read comments in a specific format to generate documentation. These comments do not affect readability. On the contrary, Javadocs are great for explaining how to use these entities. Combined with tools like my dear Doctest, we even get guarantees of accuracy and correctness! - Source: dev.to / 6 months ago

• My opinionated JavaScript package template repository - zero config, start immediately

  📚 JSDoc for documentation and jsdoc-to-markdown to create docs as markdown files. - Source: dev.to / 8 months ago

• "react-next-tilt" and "react-flip-tilt" NPM Packages

  I was already familiar with JSDoc from writing prop descriptions for my previous NPM packages, but I decided to go all in and provide more/better descriptions. I added the following information for the props of both components:. - Source: dev.to / 9 months ago

• An introduction to documenting code

  All in all, I think that this is a really good option to start understanding what it means to document but I would encourage you to do research and I am also I'm gonna leave the documentation of probably one the most used conventions to document your code. https://jsdoc.app/ Cheers. - Source: dev.to / 9 months ago

• Supercharge Your Node.js Development with This Starter Configuration

  JSDoc can be a powerful tool not only for generating TypeScript types but also for enabling type checking in your JavaScript code. By providing type annotations through JSDoc comments, you can improve code clarity, maintainability, and catch potential errors early on. In this section, we'll explore how to use JSDoc to generate TypeScript types and discuss the benefits of incorporating type checking into your... - Source: dev.to / 9 months ago

• Documenting recommended use of basic components

  Use JS Doc and Typescript for full editor annotation and autocomplete. Source: 11 months ago

• Comments - What's Your Style?

  I use JSDoc annotations, and jsdoc package to auto-generate MarkDown and HTML documentation. I use it for [this website](zuixjs.org/). It's open source. Source: 11 months ago

• Rich Harris is NOT Getting Rid of TS Support in Svelte

  Someone briefly quoted Rich Harris saying he wants to migrate the Svelte Core Code to use JSDoc instead of Typescript. This shouldn't have been that controversial, at least not for the Svelte team. Why? Because it doesn't affect you... - Source: dev.to / 11 months ago

• Mastering JSDoc: the complete guide for Javascript developers

  JSDoc is a markup language used to describe the structure and behavior of Javascript code. It provides a standard way of documenting code so that other developers can easily understand what each function, method, or class does, its input parameters, return values, and more. - Source: dev.to / 12 months ago

• Is my portfolio good enough?

  4b) go through your projects and add documentation! https://jsdoc.app/ I’m begging you! Source: about 1 year ago

• Add to array in local storage

  It’s a type annotation. It’s telling you and your IDE what type the variable is. You put it on of the line you want to comment. Check it here jsdoc. Source: about 1 year ago

• The right is on the left

  That turns out to be a pretty common use case for markdown. Github, for example, renders your README.md is part of a git repo's "home" page. It's also common to have tooling that parses specially formatted comments in your source code and produce a documentation bundle, usually as a web page (ex. RDoc, YARD, JSDoc, etc.). Source: over 1 year ago

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

• What to document?

  Use JSDoc or similar in your code - you can get this to produce an online documentation manual. Source: over 1 year ago

• Documenting Angular projects

  Keep documentation close to what is being documented: in Angular projects, JSDoc comments can be used to document components, pages and so on write on top of the source code, which is very useful and saves time. - Source: dev.to / over 1 year ago