Java教程

十二、编码规约

本文主要是介绍十二、编码规约，对大家解决编程问题具有一定的参考价值，需要的程序猿们随着小编来一起学习吧！

编码规约

    • 命名风格与代码格式
      • 命名体现代码元素特征
      • 命名最好望文知义
    • 代码格式与设计规约
    • 注释规约

命名风格与代码格式

命名体现代码元素特征

  1. 抽象类命名开头使用Base或Abstract
  2. 异常类使用Exception结尾
  3. 测试类以Test结尾
  4. 类型与中括号相连表示数组
  5. 枚举类名带上Enum后缀，成员名称大写，单词间下划线隔开

命名最好望文知义

  1. 不要使用表意不明的缩写（Condition->Condi）
  2. 不要使用拼音表示

代码格式与设计规约

  1. 大代码段不要写在一行里，否则会导致代码结构不明晰
  2. 禁止使用魔法值，敞亮必须定义static final 变量并规定好范围（命名做到表意）
  3. 常量使用大写字母，并用下划线分割

注释规约

  1. 写必要的注释，避免大量从方法名中就能很清楚理解的无用注释
  2. 写出代码中需要特别注意的事项，避免后人踩坑
  3. 写清复杂程序的执行流程，保持条理清楚
这篇关于十二、编码规约的文章就介绍到这儿，希望我们推荐的文章对大家有所帮助，也希望大家多多支持为之网！
您可能喜欢
栏目导航