clean-names 属于 Clean Code 技能集合,用途是在 TypeScript 中命名、重命名或修正变量、函数、类、接口和模块名称时提供规范指导。它围绕七条原则展开:N1 选择描述性名称,名称应直接表达意图,如用 SECONDS_PER_DAY 代替 d;N2 选择合适抽象层级的名称,避免暴露实现细节,如用 getUserDirectory() 代替 getMapOfUserIdsToNames();N3 尽量使用标准术语,如设计模式名或领域词汇,例如 UserFactory、calculateAmortization;N4 名称应无歧义,如用 renameFile(oldPath, newPath) 代替 rename(source, target);N5 作用域越长名称越长,循环内可用短名,模块级常量应使用 MAX_RETRY_ATTEMPTS_BEFORE_FAILURE 这类完整名称;N6 避免编码,不使用匈牙利命名或 I 前缀,如用 users、count、UserRepository 代替 arrUsers、nCount、IUserRepository;N7 名称应描述副作用,若函数超出名称暗示的行为则应改名,如 getOrCreateConfig 代替 getConfig。使用时可在命名或重构 TypeScript 代码时对照这七条规则与快速参考表。资料未提供安装命令、运行方式、平台限制或收费信息。
clean-names
编程与开发
更新于 10-15 21:39