返回 Skill 列表
extension
分类: 开发与工程无需 API Key

Code Documentation Style

简洁、常青的代码注释,注重解释为什么这样做而不是具体做了什么。在为复杂的逻辑、框架计算或不明显的架构决策添加注释时使用这种方法。强调通过清晰的命名和结构来自我文档化代码,而不是过多地依赖注释。

person作者: jakexiaohubgithub

Code Documentation Style

This Skill provides Claude Code with specific guidance on how it should handle global commenting.

When to use this skill:

  • Documenting complex animation timing calculations
  • Explaining non-obvious frame-based logic
  • Adding context for architectural decisions
  • Documenting tricky Remotion or S3 edge cases
  • Clarifying business rules in validation logic
  • Adding JSDoc for public function interfaces

Instructions

  • Self-Documenting Code: Write code that explains itself through clear structure and naming
  • Minimal, helpful comments: Add concise, minimal comments to explain large sections of code logic.
  • Don't comment changes or fixes: Do not leave code comments that speak to recent or temporary changes or fixes. Comments should be evergreen informational texts that are relevant far into the future.