Java开发代码规范之编程规约---命名风格

68 阅读 0 评论 45 点赞

我是靠谱客的博主能干电话，最近开发中收集的这篇文章主要介绍Java开发代码规范之编程规约---命名风格，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

前言

一个软件生命周期中，从可行性研究分析、计划到需求分析，再到软件设计、编码实现、测试，最后交付使用，运行维护过程中，维护过程占据了很大的比例，一个软件的生命周期中，很难保证自始至终都由最初的开发人员来维护。作为一个开发人员，他可能会把自己手头上的工作转交给其他人，也可能会从其他开发人员手中接手其他任务。面对一个庞大的系统，开发人员怎么才能快速、高效的做好交接工作，让别人读懂自己的代码，自己又能看懂他人的代码，给他人和自己带来方便呢？这就需要开发人员在编码过程中都遵守一些约定俗成的规范，这样既能方便自己也能方便他人。
编程规范是对编程的一种约定，主要的作用就是增强代码的规范性，提高我们编写代码的质量，为后续再返回看自己的之前的代码，或者给他人看我们自己的代码提供一种便利，易于理解、方便阅读，增加代码的可维护性。

正文

命名总体原则：

1.从业务出发，名字能表示事物的特性;
2. 使用英文单词，不能为拼音/汉字；
3. 名字长度不应多于4个单词，控制在3-30个字母以内；
4. 采用驼峰命名法；
5. 命名避免与关键字冲突；

1、方法命名：
增加/插入方法用add作为前缀；
删除方法用delete作为前缀；
更改/更新方法用update作为前缀；
查询/获取单个对象方法用find作为前缀；
查询/获取多个对象方法用query作为前缀。
2、属性
以名词或形容词命名；
使用Pascal大小写；
禁止缩写；
Javabean属性命名使用常用的驼峰命名规则；
属性名第一个单词避免使用一个字母：eMail；
boolean属性名避免使用“is”开头的名称,因为这和JavaBean规范中bool类型取值操作命名冲突，取值规范是isXXX；
在类属性中不需要包含类名。
3、常量const
禁止缩写；
采用完整的英文大写单词，词之间用下划线连接；
命名简短，<16个字符；
同一组的常量可以用常量类封装在一起，方便引用和维护；
代码中用到常量的，使用静态常量表示。
4、变量和字段
private、protected 使用 Camel 大小写；
禁止使用public；
字段命名规范，使用驼峰命名；
对于主键字段， id命名:如：studentId，需要加上与实体类相关的名称;
对于时间类型的字段，采用dateTime, 格式：YYYY-MM-dd HH:mm:ss;
布尔变量名应该包含 Is，这意味着 Yes/No 或 True/False 值，如 fileIsFoundl;
DataSet类型的变量以ds开头，DataTable类型的变量以table开头;
在变量名中使用互补对，如 min/max、begin/end 和 open/close;
即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如 i 或 j;
对不易清楚识别出该变量类型的变量应使用类型缩写作其前缀，如字符串使用strXXX,boolean使用isXXX;
命名简短，<16个字符；
静态字段：使用名词、名词短语或者名词的缩写命名静态字段；Pascal命名法。