global-commenting
Establish clear and maintainable comments throughout JavaScript modules, CSS, and HTML files in this static website project. Use this skill when adding, updating, or reviewing comments in source code to ensure they follow consistent conventions and improve code readability.
When & Why to Use This Skill
This Claude skill automates and standardizes code documentation across JavaScript, CSS, and HTML files. It ensures that your static website project maintains high readability and follows consistent commenting conventions, making it easier for developers to understand complex logic, function parameters, and UI structures while reducing technical debt.
Use Cases
- Documenting complex JavaScript logic and function parameters to improve team collaboration and code maintainability.
- Adding descriptive comments to CSS selectors and rules to clarify the intent behind specific visual styles and layout fixes.
- Organizing HTML files with header comments to clearly define section purposes and improve project navigation.
- Reviewing and updating existing comments during refactoring to ensure documentation remains synchronized with the latest code changes.
- Implementing standardized TODO and FIXME comments to effectively track technical debt and planned site enhancements.
| name | Global Commenting |
|---|
Global Commenting
This Skill provides Claude Code with specific guidance on how to adhere to coding standards as they relate to how it should handle global commenting in the adigunners.github.io static website project.
When to use this skill
- Adding comments to JavaScript modules in the
js/directory to explain complex logic or non-obvious functionality - Documenting function purposes and parameters in vanilla JavaScript code
- Adding clarifying comments to CSS selectors and rules in
css/styles.cssthat achieve specific visual effects - Writing header comments in HTML files (
index.html,winners.html) to describe section purposes or layout structure - Ensuring comments in JSON data files (
data/directory) explain any non-standard data formats or conventions - Reviewing existing comments during refactoring to ensure they remain accurate and aligned with current code
- Adding TODO or FIXME comments to mark areas for future improvement in the static site
Instructions
For details, refer to the information provided in this file: global commenting