global-commenting

adigunners 的头像作者 adigunners

在本静态网站项目中建立清晰且可维护的注释。在添加、更新或审查源代码中的注释时使用此技能,以确保它们遵循一致的约定并提高代码可读性。

📖 中文导读:在本静态网站项目中建立清晰且可维护的注释。在添加、更新或审查源代码中的注释时使用此技能,以确保它们遵循一致的约定并提高代码可读性。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: Global Commenting description: 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.

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.css that 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