AgentSkillsCN

Global Commenting

为组件与API编写JSDoc注释，阐明技术决策背后的“为什么”、复杂逻辑，以及不直观的实现方式。在为组件Props文档化、解释复杂算法、标注性能优化、记录规避方案，或补充API文档时使用此技能。在处理需要JSDoc文档化的组件Props接口、复杂的业务逻辑或算法、性能优化的原理、浏览器兼容性的规避方案或技巧、带有请求/响应格式的API路由文档、配置文件说明、内容集合架构文档，或正则表达式及其匹配规则时使用此技能。

SKILL.md
--- frontmatter
name: Global Commenting
description: Write purposeful code comments that explain the "why" behind technical decisions, complex logic, and non-obvious implementations using JSDoc for components and APIs. Use this skill when documenting component props, explaining complex algorithms, noting performance optimizations, documenting workarounds, or adding API documentation. When working on component prop interfaces requiring JSDoc documentation, complex business logic or algorithms, performance optimization rationale, browser compatibility workarounds or hacks, API route documentation with request/response formats, configuration file explanations, Content Collection schema documentation, or regex patterns and what they match.

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.

When to use this skill

  • •When documenting component props with JSDoc (@prop, @param annotations)
  • •When explaining complex algorithms, business logic, or non-obvious implementation choices
  • •When documenting performance optimizations and the rationale behind them
  • •When noting browser compatibility issues or workarounds for bugs
  • •When documenting API routes with request/response format specifications
  • •When explaining Content Collection Zod schemas and validation constraints
  • •When clarifying regex patterns and what they're designed to match
  • •When documenting configuration files (astro.config.mjs, tailwind.config.mjs)
  • •When adding file-level documentation headers for complex components or utilities
  • •When explaining technical debt, TODOs, or future refactoring needs
  • •Avoiding commenting obvious code, change history (use git), or commented-out code blocks

Instructions

For details, refer to the information provided in this file: global commenting