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命名法。
Java开发代码规范之编程规约---命名风格相关推荐
- Java 编码规范1(编程规约-命名风格)
编程规约-命名风格 其它相关文章 Java 编码规范1(编程规约-命名风格) Java 编码规范2(编程规约-常量定义) Java 编码规范3(编程规约-代码格式) Java 编码规范4(编程规约-O ...
- java标识命名服务_阿里巴巴Java开发规约第一章编程规约-命名风格篇
1.[强制] 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束. 反例: _name /__name / $name / name_ / name$ / name__ 老四附言: ...
- 阿里巴巴对Java编程【命名风格】的规约
转载自 阿里巴巴对Java编程[命名风格]的规约 命名风格 1. [强制]代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束. 反例: _name / __name / $Obje ...
- 中科方德java开发编码规范_插件推荐:如何将Java编码规范落地实际开发中
一个软件需要花费80%的生命周期成本去维护. 几乎没有任何软件的整个生命周期仅由其原作者来维护. 编码规范改善软件的可读性,让工程师更快更彻底地理解新的代码. 如果你将源代码转变为一个产品,那么您需要 ...
- 黑马前端h5团队开发代码规范
黑马前端h5团队开发代码规范 1. 概述 欢迎使用品优购代码规范, 这个是我借鉴京东前端代码规范,组织的品优购内部规范.旨在增强团队开发协作.提高代码质量和打造开发基石的编码规范, 以下规范是团队基本 ...
- C语言代码规范(编程规范)
首页 > 编程笔记 > C语言笔记 阅读:7,165 C语言代码规范(编程规范) C语言中文网推出辅导班啦,包括「C语言辅导班.C++辅导班.算法/数据结构辅导班」,全部都是一对一教学:一 ...
- 【C 语言】C 项目开发代码规范 ( 形参合法性判断 | 函数返回值局部变量 | 函数中不用全局变量 | 函数中使用局部变量接收形参 | 函数返回值 | 形参作返回值 | 形参返回值处理 )
文章目录 一.C 项目开发代码规范 一.C 项目开发代码规范 上一篇博客 [C 语言]字符串模型 ( 键值对模型 ) 中 , 完成了字符串的 键值对 查找功能 , 代码不太规范 ; C 项目开发代码规 ...
- [转载]Object-C 声明属性为什么用下划线,代码规范和编程风格_s芃成_新浪博客...
原文地址:Object-C 声明属性为什么用下划线,代码规范和编程风格 作者:贞娃儿 在阅读和书写关于iPhone编程的代码的时候,发现有很多这样的情况: 看到很多源代码里面,使用前面带下划线变量,然 ...
- JAVA 开发统一规范(规约)
开发统一规范: 类和方法需要添加注释,其他比较复杂的地方也需要添加注释 单个方法的总行数不超过 80 行.说明:除注释之外的方法签名.左右大括号.方法内代码.空行.回车及任何不可见字符的总行数不超过 ...
最新文章
- 干掉 FastJson
- NS2仿真:公交车移动周期模型及性能分析
- 开机流程与主要开机记录区(MBR)
- Soring冲刺计划第三天(个人)
- VTK:可视化之NamedColorPatches
- php键名改为0.1.2.3,揭秘 0.1 + 0.2 != 0.3(php 请自觉点用round)
- 汇编语言(三十五)之输入字符串以$结束然后输出字母个数
- 作业 给计算机编号 winform
- C/C bit 位操作
- AcWing 1843. 圆形牛棚(暴力+枚举)
- linux系统nohob安装,Linux启动详解1
- 智能优化算法应用:基于麻雀搜索优化K-means图像分割算法 - 附代码
- base64码通过http传输 +号变 空格 问题解决
- 完全免费一级域名强注册地址 免费二级域名注册地址
- VOT-toolkit Python 版本使用教程--官方样例版
- svnserve服务器
- 分批处理list中的数据_如何分批次处理List集合中的数据
- 记录一次工作中的问题以及解决(POI对于Excel的数据导出覆盖问题)
- 江西赣州移动宽带DNS
- 越狱后的iBooks问题
热门文章
- [译] 单元测试,精益创业,以及两者之间的关系
- NHibernate初探-SQLDialects
- Nested Loop,Sort Merge Join,Hash Join
- 盛大云主机 就是价格有点贵啊
- Refer to the WebSite
- intellij自动生成构造函数
- 大数据架构如何挑选机器.
- TPC-H生成Spark测试用的伪数据集(转载)
- pyspark报错java.lang.ClassNotFoundException: com.mysql.cj.jdbc.Driver
- datatable和awk获取列名操作