Naming Analyzer 说明文档

# 命名分析器技能 这是一个用于 Claude Code 的技能，它能够分析代码命名规范，并根据上下文和行业标准建议更好的变量、函数、类及其他标识符名称。 ## 目的 良好的命名是代码可读性和可维护性最重要的方面之一。此技能可帮助开发者： - **识别命名问题**：在现有代码成为技术债务之前发现问题 - **提高代码清晰度**：用描述性名称替换模糊或误导性的名称 - **强制执行一致性**：通过遵循特定语言的规范在整个代码库中保持统一 - **降低认知负荷**：减轻阅读或维护代码人员的负担 糟糕的命名会导致 Bug、困惑和时间浪费。此技能充当专门针对命名质量的专家级代码审查员。 ## 何时使用 当您想要执行以下操作时使用此技能： - 审查文件、目录或整个代码库中的命名规范 - 获取关于变量、函数或类名的改进建议 - 检查代码是否遵循特定语言的命名规范 - 识别与实际行为不符的误导性名称 - 清理不清晰的缩写或单字母变量 - 使用正确的前缀标准化布尔值命名 **触发短语：** - "Analyze the naming in this file" (分析此文件中的命名) - "Suggest better names for my variables" (为我的变量建议更好的名称) - "Check naming conventions in src/" (检查 src/ 中的命名规范) - "Review this code for naming issues" (审查此代码的命名问题) - "Help me rename these functions" (帮我重命名这些函数) ## 工作原理 1. **分析阶段**：该技能检查目标代码中的所有标识符： - 变量和常量 - 函数和方法 - 类、接口和类型 - 文件和目录 - 数据库表和列 - API 端点 2. **问题检测**：评估每个标识符是否存在常见问题： - 不清晰或模糊的名称 (`data`, `info`, `temp`, `x`) - 掩盖含义的缩写 (`usrCfg`, `calcTtl`) - 不一致的命名规范 (混合使用 `camelCase` 和 `snake_case`) - 误导性名称 (名为 `getUser` 的函数却同时更新了数据) - 名称过短或过长 - 循环上下文之外的单字母变量 - 缺失布尔前缀 (使用 `active` 而非 `isActive`) 3. **规范检查**：该技能根据特定语言的标准进行验证： - JavaScript/TypeScript：变量/函数使用 camelCase，类使用 PascalCase - Python：变量/函数使用 snake_case，类使用 PascalCase - Java：变量/方法使用 camelCase，类使用 PascalCase