JSDoc VS Fresh Framework

• Improved Documentation
  JSDoc generates detailed HTML documentation from comments, which improves the maintainability and readability of the codebase.
• Enhanced Code Understanding
  By using JSDoc, other developers can easily understand the purpose and usage of functions, parameters, classes, etc.
• Autocomplete and Type Checking
  When integrated with editors like Visual Studio Code, JSDoc comments can provide better autocomplete suggestions and can be used for TypeScript-like type checking.
• Consistency
  JSDoc enforces consistent documentation across the codebase, ensuring that all parts of the code are equally documented.
• Easy to Use
  It is relatively straightforward to incorporate JSDoc comments into existing JavaScript code with minimal effort.
• Supports Multiple Formats
  JSDoc supports various formats and tags, making it versatile for different documentation needs.

Possible disadvantages

• Learning Curve
  New users may need some time to fully understand and utilize all the features and tags available in JSDoc.
• Manual Effort
  Writing JSDoc comments requires a manual effort from developers, which can be time-consuming especially for large codebases.
• Not Enforced
  Without proper enforcement, developers might omit JSDoc comments, leading to inconsistent documentation.
• Overhead
  Too many comments can make the codebase cluttered and harder to navigate in some cases.
• Limited to JavaScript
  JSDoc is primarily designed for JavaScript, which can be limiting if the project includes multiple languages.

• Performance
  Fresh takes advantage of Deno's fast runtime and server-side rendering, minimizing latency and improving performance by generating HTML content on the server side.
• TypeScript Support
  Fresh supports TypeScript out of the box, enabling developers to write type-safe code, which enhances code reliability and maintainability.
• Modern JavaScript
  Fresh is built with modern JavaScript features and uses ES modules, which supports a more modular and efficient codebase.
• No Build Step
  Fresh doesn't require a bundling or build step, as it uses native ES modules. This simplifies the development workflow and reduces complexity.
• Deno Integration
  Being tightly integrated with Deno, Fresh benefits from Deno's security model, tooling, and standard library.

Possible disadvantages

• Ecosystem Maturity
  Fresh and the Deno ecosystem are relatively new compared to other frameworks like React or Node.js, which may result in limited third-party libraries and community support.
• Learning Curve
  Developers familiar with the Node.js ecosystem might face a learning curve when adapting to Deno and Fresh due to different APIs and features.
• Hosting Options
  Since Deno is newer, there are fewer hosting providers that natively support it compared to Node.js, potentially complicating deployment.
• Tooling
  The tooling around Fresh and Deno may not be as mature or feature-rich as those for more established frameworks like React or Angular.

ep1 - Documenting your javascript code like a pro, setting up JSdoc

More videos

No Fresh Framework videos yet. You could help us improve this page by suggesting one.

• 20 Best Web Project Documentation Tools
  bashooka.com · Sep 2020

  It is to Sass what JSDoc is to JavaScript: a documentation system to build pretty and powerful docs in the blink of an eye.

We have no reviews of Fresh Framework yet. Be the first one to post

• Express Setup: Simple & Scalable

  In our JSDoc comments we describe our endpoints to using a set of tags, you can look at the different tags and what they do over on JSDoc's website but here's what we've used and why. - Source: dev.to / over 1 year ago

• Connecting the Custom Elements Manifest to Figma Code Connect

  Most analysers that generate a Custom Elements Manifest operate by extending JSDoc comments. In our case, we'll need to add a @figma tag to our component comments so that we can tie the two together. The URL provided here can be found... - Source: dev.to / about 1 year ago

• Ask HN: Abandoned/dead projects you think died before their time and why?

  If your IDE supports JSDoc, then TS isn't needed for basic type constraints. https://jsdoc.app/. - Source: Hacker News / about 1 year ago

View more

• You're Doing Rails Wrong

  It's not so bad if you're doing it professionally because you pretty much set it up once and you're done. But yeah it's annoying for one-off projects or if web dev isn't your main job. That said you can avoid it. I wrote a website using... - Source: Hacker News / about 1 year ago

• Deno 2.4

  I would highly recommend giving Deno Fresh[1] a go, it has a lot of the same features as Next.js but I find it to result in a much cleaner codebase overall. This coupled with Deno's built in KV store and hosted on Deploy makes for quite... - Source: Hacker News / over 1 year ago

• FDLD - Fatigue Driven Lack of Development

  Ummm... Well I am mostly a web dev so I will try out the Fresh 🍋 framework to make something simple like an app where a user can log their mood (why not 🦀). - Source: dev.to / almost 2 years ago

View more