Global Commenting

The Global Commenting skill is designed to help developers maintain clear, consistent, and informative comments across a static website project, specifically targeting JavaScript, CSS, HTML, and JSON files. By standardizing how comments are added, updated, and reviewed, this skill addresses the common problem of unclear or inconsistent documentation within codebases. It ensures that developers and collaborators can quickly understand complex logic, design decisions, and non-obvious functionality, reducing the risk of errors and improving maintainability over time.

This skill provides capabilities to annotate JavaScript modules with explanations for intricate logic or function behavior, document parameters and function purposes, clarify CSS selectors and styling rules, and add descriptive header comments in HTML files to outline section purposes or page structure. Additionally, it supports commenting in JSON data files to explain custom formats or conventions, and facilitates the inclusion of TODO and FIXME markers for future improvements. By offering structured guidance on comment placement and content, it helps maintain alignment with coding standards and project conventions, ensuring that documentation evolves alongside code changes.

Target users include frontend developers, web designers, and code reviewers who work on static website projects, particularly those using vanilla JavaScript, CSS, and HTML. Typical use cases include adding new comments when implementing features, updating existing comments during refactoring, reviewing code to ensure documentation accuracy, and marking areas for future enhancement. By using this skill, teams can achieve better readability, reduce onboarding time for new contributors, and create a more maintainable and professional codebase.