mcpField
T
the-art-of-naming

the-art-of-naming

github.com/develite98开发1940 次安装38 周前更新
代码仓库

关于 the-art-of-naming

The Art of Naming 是一项代码命名技能，为变量、函数、类型等代码元素提供结构化指南，适合希望统一规范并提高可读性的开发者和团队，规则按优先级组织并附有示例文件。

主要功能

  1. 01按代码元素采用大小写规范
  2. 02使用简短直观且明确的名称
  3. 03遵循前缀和布尔命名规则
  4. 04避免成员名称重复上下文
  5. 05根据操作选择函数动词

适用场景

  1. 01为新代码中的元素命名
  2. 02检查命名一致性
  3. 03通过重命名改善可读性
  4. 04制定项目 lint 规范

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/develite98/angular-best-practices --skill the-art-of-naming

安装后在 Claude Code 中输入/the-art-of-naming确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

AGENTS.md
metadata.json
rules/
naming-boolean.md
naming-casing-convention.md
naming-context-duplication.md
naming-function-pattern.md
naming-prefix-convention.md
naming-sid.md
naming-variable-pattern.md

详细介绍

命名的艺术

给事物命名很难。本指南提供了一套结构化方法，用于为变量、函数、类、接口及其他各种内容命名，从而编写自我说明、一致且易读的代码。

适用场景

在以下情况下，请参考这些指南：

  • 为新变量、函数、类、接口或类型命名
  • 检查代码中的命名一致性
  • 重构代码以提高可读性
  • 为新项目设置 lint 规则
  • 帮助新团队成员熟悉代码库约定

核心原则

  • S-I-D — 每个名称都必须简短（Short）、直观（Intuitive）且描述清晰（Descriptive）
  • 不要使用缩写 — 使用 onItemClick，不要使用 onItmClk
  • 使用正确的大小写 — 成员使用 camelCase，类型使用 PascalCase，常量使用 UPPER_CASE
  • 使用有意义的前缀 — 接口使用 I，私有成员使用 _，布尔值使用 is/has/should
  • 避免重复上下文 — 使用 MenuItem.handleClick()，不要使用 MenuItem.handleMenuItemClick()
  • 遵循结构化模式 — 变量使用 P/HC/LC，函数使用 A/HC/LC
  • 使用正确的动作动词 — get（同步）、fetch（异步）、remove（集合）、delete（永久删除）

按优先级划分的规则类别

优先级规则影响文件
1大小写约定严重naming-casing-convention
2S-I-D + 不使用缩写严重naming-sid
3前缀约定高naming-prefix-convention
4布尔值命名高naming-boolean
5上下文重复高naming-context-duplication
6函数命名（A/HC/LC）高naming-function-pattern
7变量命名（P/HC/LC）中naming-variable-pattern

快速参考

1. 大小写约定（严重）
  • naming-casing-convention — 变量和函数使用 camelCase，类、枚举和类型使用 PascalCase，导出常量使用 UPPER_CASE
2. S-I-D + 不使用缩写（严重）
  • naming-sid — 名称必须简短、直观且描述清晰——绝不使用缩写
3. 前缀约定（高）
  • naming-prefix-convention — 接口使用 I，私有成员使用 _，泛型使用 T/R/U/V/K
4. 布尔值命名（高）
  • naming-boolean — 布尔值使用 is/has/should/can 作为前缀，并使用正向名称
5. 上下文重复（高）
  • naming-context-duplication — 不要在成员名称中重复类名或组件名
6. 函数命名（高）
  • naming-function-pattern — 遵循 A/HC/LC 模式，并使用正确的动作动词（get/set/fetch/remove/delete/compose/handle）
7. 变量命名（中）
  • naming-variable-pattern — 遵循 P/HC/LC 模式，让变量名称结构清晰、易于预测

使用方法

阅读各个规则文件，了解详细说明和代码示例：

rules/naming-casing-convention.md
rules/naming-sid.md
rules/naming-prefix-convention.md
rules/naming-boolean.md
rules/naming-context-duplication.md
rules/naming-function-pattern.md
rules/naming-variable-pattern.md

每个规则文件都包含：

  • 对规则重要性的简要说明
  • 附带说明的不正确代码示例
  • 附带说明的正确代码示例
  • 汇总表和参考资料

完整汇编文档

如需查看包含所有规则完整内容的指南，请参阅：AGENTS.md

评论

支持 Markdown