起一个名字实在太重要了,昨日审查代码发现团队小伙伴同样一套代码起了leadSomeThing,看到这个起名让我一脸懵逼😳。细问才知,他的本意领取某个东西。好家伙!硬生生中文造英文词。本着不放过任何问题的态度,我整理了一份关于命名的几套标准思路,希望各位造词党高抬贵手,放过那些变量和方法,给他们应有的名分吧!
如何起好的名字
起的名字是有意义的
不要像:
a、arr、tmp
应当:
article、courseArray、tmpFile
要考虑名字的长度
不要像:
let consecutivePasswordErrorTimes
const filedsWithUserIdAndQuestionNumAndQuestionAndHashedAnswerAndAnswerSalt
名字要遵守规范
const MAX_NUM: number = 10; // 常量
let newClass: number = 10; // 变量
class CourseService {} // 类名
const getCourse = (id: number): Course => {} // 方法
- 一个名字不要表示多种概念,一个概念不要用多种名字来表示
- 多使用领域知识中的专有名词
types 如何命名
重要的事情说三遍:大驼峰!大驼峰!大驼峰!
type User = {}
interface Filter {}
GIT 分支命名
- BUG修复分支: bugfix/{ID}
- 紧急修复分支: hotfix/{ID}
- 特性功能分支: feature/{ID}-{feature_name}