Semantic UI VS JSDoc

• Intuitive Class Names
  Semantic UI uses human-readable class names that describe their purpose, making it easy to understand and write code without consulting documentation frequently.
• Customizability
  Semantic UI allows for deep customizability with its theming, letting developers adjust the default designs to match specific project requirements.
• Comprehensive Components
  Semantic UI provides a wide range of pre-built components like buttons, forms, and modals, which can significantly speed up development time.
• Flexibility
  The framework offers flexibility in terms of its modular structure, enabling developers to import only the components they need.
• Detailed Documentation
  Semantic UI has detailed and well-organized documentation, which helps developers quickly resolve issues and understand how to use various features.

Possible disadvantages

• Large File Size
  The framework's comprehensive nature can lead to larger file sizes, which might affect the load times of web applications.
• Learning Curve
  Despite its intuitive naming conventions, the breadth of components and features can result in a steep learning curve for new developers.
• Community Support
  Unlike more popular frameworks like Bootstrap, Semantic UI has a smaller community, which can mean fewer third-party plugins and community support.
• Incomplete Integration
  Some integrations with newer JavaScript frameworks such as React or Vue might require extra effort or third-party libraries, given that Semantic UI is not natively designed for them.
• Infrequent Updates
  The development and updates to Semantic UI have been less frequent compared to other UI frameworks, potentially leading to compatibility and security issues.

• 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.

Semantic UI In 60 Minutes

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

More videos

• 22 Best Bootstrap Alternatives & What Each Is Best For
  thectoclub.com · May 2024

  I chose Semantic UI because of its intuitive and accessible approach to design. Its use of human-friendly HTML sets it apart from many other frameworks, making it a more natural choice for developers prioritizing...

• 10 Best Free React UI Libraries in 2023
  www.wearedevelopers.com · Sep 2023

  The styling of Semantic UI React is based on the Semantic UI theme and it's also free from jQuery. Apart from that, there are other useful features like augmentation, shorthand props, auto controlled state, etc.

• 11 Best Material UI Alternatives
  www.uxpin.com · Jul 2023

  Semantic UI supports theming and customization, allowing developers to customize the appearance of their UI components to align with their project’s branding. With its intuitive syntax and detailed documentation,...

View more

• 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.

• Oat – Ultra-lightweight, semantic, zero-dependency HTML UI component library

  Nice solution. Reminds me of https://semantic-ui.com/ and https://fomantic-ui.com/. - Source: Hacker News / 9 months ago

• JavaScript Awesome Package

  Semantic-UI - User Interface is the language of the web. - Source: dev.to / 9 months ago

• 100+ Must-Have Web Development Resources

  Semantic UI: A fully semantic front-end development framework. - Source: dev.to / about 2 years ago

View more

• 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