代码规范

本文最后更新于:2021年1月19日 晚上

命名风格

编程界常⽤的⼏种命名⻛格分别是:⼤驼峰⻛格、⼩驼峰⻛格、匈⽛利⻛格和蛇形⻛格

名称 规则 例子
⼤驼峰⻛格 每个单词的⾸字⺟均以⼤写呈现 UserModel、 CrontabRule、 PandaCount
⼩驼峰⻛格 第⼀个单词的⾸字⺟以⼩写呈现 userModel、 crontabRule、 pandaCount
匈⽛利⻛格 命名⻛格剑⾛偏锋,不是很好描述 m_lpszStr 表示指向⼀个以 0 字符结尾的字符串的⻓指针成员变量
蛇形⻛格 ⽤下划线作为单词之间的连接符号,所有字⺟均以⼩写呈现 user_model、crontab_rule、 panda_count

不同编程语⾔所推崇的⻛格亦不相同

  • Java 开发者、Golang 开发者习惯使⽤驼峰⻛格
  • Python 开发者则推崇蛇形⻛格
  • Rust 开发者就会同时使⽤驼峰⻛格和蛇形⻛格。

命名原则

给对象起⼀个有意义、含义明确、⽆副作⽤、不会引起误导的名称,名字⻓⼀些不要紧
重要的是要让人一眼就明白它的含义

  • 类名、包名、⽂件名、项⽬名、变量名、常量名⽤名词
  • 函数名⽤动词或者动词配合名词
    例如 get、 take、 push、 extract、extract_digest、get_number、 take_tickets
  • 项⽬名、包名、⽂件名、类名对应的单词可以⽤复数形式表示
  • ⻓度控制在 5 个单词内,追求⻅名知意
  • 不要占⽤语⾔或者系统保留词
  • 不要使⽤简短的字⺟或者单词缩写作为名称
  • 类名、包名、⽂件名、项⽬名、变量名、常量名不应包含动词;
  • 名称中除了字⺟和下划线外,不应包含其他字符
  • 接⼝名、抽象类名、基类名、异常类名、错误类名以特定的单词开头或结尾,例如 TimeException、StorageBase、 PermissionInterface、 ParseError

本博客所有文章除特别声明外,均采用 CC BY-SA 4.0 协议 ,转载请注明出处!