Mar 3 · 9 min read · Code Documentation Generators: TypeDoc, JSDoc, Sphinx, rustdoc, and Modern Alternatives Code documentation generators read your source code -- its types, comments, and structure -- and produce browsable reference documentation. The good ones make you...
Join discussionApr 16, 2025 · 3 min read · Type Narrowing allows the IDE (development environment) to narrow down the object type, from a union type, to a more specific type. Bullsh*t Example In this bullsh*t example, value is the union type string | number, meaning it can either be a string ...
Join discussionAug 20, 2024 · 2 min read · This article is inspired by Remotion’s internal package, ai-improvements. This internal package is used to improve/generate JSDoc comment and log in the console for a function in the Remotion’s source code. This use case is quite different because yo...
Join discussion
Apr 23, 2024 · 9 min read · I want to preface this article by saying and [spoiler alert], while I might agree with Svelte's decision to migrate to JSDoc and see the benefits it offers over TypeScript, I'm still a HUGE fan of TypeScript and all the awesome features it brings to ...
Join discussion
Apr 12, 2024 · 2 min read · While documenting JavaScript code using JSDoc, I stumbled upon an annoying issue. My attempts to include the /* symbol in the example code within a multiline comment caused the entire comment block to break. This happens because */ is recognized as t...
Join discussionJan 12, 2024 · 7 min read · A callback function is a function passed into another function as an argument, which is then invoked inside the outer function to complete some kind of routine or action. -- MDN: Callback function Callbacks are used all over in JavaScript, a good ex...
Join discussionJan 11, 2024 · 2 min read · Each time I see an article (like this one) about typescript, they never quite seem to mention jsdocs. Therefore, it always feels like an unfair, one-sided comparison. Let's dive in some of the typical examples. Type safety This is probably the bigges...
NBNenad and 1 more commented
Dec 3, 2023 · 9 min read · Welcome to this week's exploration where we delve into the transformative power of JSDoc in enhancing your JavaScript projects. In this guide, I aim to provide you with a clear understanding of JSDoc's capabilities and its impact on your codebase. Wh...
Join discussion
