JSDoc Reviews

DocFX Reviews

JSDoc mentions (51)

• 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 / 16 days 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 / 18 days 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 month 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 / 3 months 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 / 4 months ago

DocFX mentions (7)

• TSDocs.dev: type docs for any JavaScript library

  This is a better looking version of what Java and C# have had for a long time (kudos to the author for that!), is that the inspiration for this tool? https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html https://dotnet.github.io/docfx/ I saw the author mentioned in another comment that they found themselves peeping inside type declaration files "too often". While I do often use sites generated... - Source: Hacker News / 6 months ago

• What Does Microsoft Use to Create their KB Articles?

  Actually, we use it for OptiTune, it's called "docfx" https://dotnet.github.io/docfx/. Source: over 2 years ago

• Library / Codebase Documentation - Multiple aggregated libraries - How to create? DocFx does not support this?

  We would really prefer to use a somewhat generic pre-made tool for this (such as DocFX) compared to rolling our own solution. We can roll our own solution... But would prefer not to so that we can minimize development and maintenance overhead. Source: over 2 years ago

• CSharp Docuementation Site

  I use docfx from microsoft to generate documentation for all my oss libraries. Source: over 2 years ago

• What platform is Microsoft Docs hosted on?

  My best guess would be that there's a CI/CD pipeline in GitHub that utilizes DocFX to convert the Markdown files to HTML. The constructed HTML files are then placed in an Azure Storage account that configured for Static Website Hosting combined with Azure CDN. Source: over 2 years ago