Skip to main content
命名
命名的重要性
- 好的设计从命名开始
简洁
- 过度点缀
- 明确所在的前提,背景,范围
- 在test 文件夹里面的xxx_test.cpp 里面定义一个 class xxx_test,这里的文件名和类的test是多余的
- 在cmake里面定义一个测试可以命名成 xxx_test ,这里的test不多余,因为平行的有 xxx
- 过度设计
- 定义太多不必要的抽象、名词
- 会给使用者/阅读者造成难度和压力
- 命名空间、类(面向对象)的组织要有一定的层级和明确的结构关系
- 统一前后的名词
- 同一种事物/抽象/表示,在所有的地方使用一个名字,大小写和命名规则也一致
- cpu_state cpu_states cpu_s c_state cs
- 不良设计
- 歧义
设计
- 通过命名引导读者理解设计意图
- auto cpu53 = A53(); auto cpu45 = A45(); cpu53和cpu45明确引导读者,这都是cpu只不过对应不同的类型。
- 多单词命名的合理排序
- BreakpointInsert BreakpointRemove BreakpointRemoveAll
- InsertBreakpoint RemoveBreakpoint RemoveAllBreakpoint
怎么在团队内统一命名规则
- 制定规则和培训