JSDoc Reviews and details

Social recommendations and mentions

• Documenting Web Components With Storybook

  One of the best tools available in Web Component development is the Custom Elements Manifest. It's a JSON representation of all your available components, covering all the attributes, methods, slots and events they support, powered by your JSDoc comments and TypeScript types. You can customize the manifest generation through plugins to support custom JSDoc comments, allowing you to power more pieces of your... - Source: dev.to / 3 months ago

• Just Say No to JavaScript

  I've seen several ways of annotating Javascript that IDEs seem to understand. They usually involve using comments before fields, classes, or functions. The most compliant one seems to be using [JSDoc](https://jsdoc.app/). JSDoc is mostly intended for generating documentation. However, the Typescript compiler can validate types (and can even interoperate with Typescript definitions), if you configure it as such. In... - Source: Hacker News / 5 months ago

• TypeScript (and JSDoc) vs JavaScript

  If you choose to use JSDoc instead of TypeScript, this only con that TypeScript has is gone, but a new one appears: JSDoc doesnt work very well with more complex types if you dont use classes to represent them. - Source: dev.to / 7 months ago

• How to document your JavaScript package

  Thanks to JSDoc it's easy to write documentation that is coupled with your code and can be consumed by users in a variety of formats. When combined with a modern publishing flow like JSR, you can easily create comprehensive documentation for your package that not only fits within your workflow, but also integrates directly in the tools your users consume your package with. This blog post aims to cover best... - Source: dev.to / about 1 year ago

• Deep Dive: Google Apps Script - Testing APIs and Automating Sheets

  Note: For simplicity, I will omit the JavaScript documentation, but for a production grade code you may want to add the documentation (see jsdoc.app website for more). - Source: dev.to / about 1 year ago

• Figma's Journey to TypeScript

  You may like JSDoc[1] if you just want some type-safety from the IDE without the compilation overhead. It’s done wonders when I’ve had to wrangle poorly commented legacy JavaScript codebases where most of the overhead is tracing what type the input parameters are. Personally, I’m impartial to TypeScript or JSDoc at this point. But I’d rather have either over plain JavaScript. [1] https://jsdoc.app/. - Source: Hacker News / about 1 year ago

• 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 year 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 / about 1 year 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 / over 1 year 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 / over 1 year 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 / over 1 year 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 / over 1 year 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 / over 1 year 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 / almost 2 years 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 / almost 2 years 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 / almost 2 years 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 / almost 2 years ago

• Documenting recommended use of basic components

  Use JS Doc and Typescript for full editor annotation and autocomplete. Source: almost 2 years 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: about 2 years 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 / about 2 years 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 / about 2 years ago