Java基础之 规范篇

引言

在我们的Java学习中，可能有很多人写的代码都能实现功能，但是不是那么规范，为什么规范那么重要呢。

首先，最直接的就是美观了，有规范的代码看起来赏心悦目，没有规范的代码看起来一团乱糟糟的，让人看都不想看。

第二，就是对于之后代码的维护了，如果出现bug，要修改代码时，规范的代码改起来会轻松一些，没有规范的代码改起来心情就不是那么美妙了。

所以，我们的代码一定要写得规范，我们对待代码要像对待一件艺术品一样，使他尽可能的好看。

一、强制要求系列

1、包名

①使用小写字母，例如com.xxx.set
②其中com是公司域名后缀，xxx是公司名称，set是表达包的内容的含义的英文

2、文件名即类名

①必须使用帕斯卡命名法，即每个单词的首字母大写，例如：BigBoy
②文件名不能随意取，必须是能够表达文件所要做的事的英文

3、变量名

①必须使用驼峰命名法，即第一个单词的首字母小写，后面的单词的首字母大写，例如：bigBoy

4、方法名

①必须使用驼峰命名法，例如：getName()
②动词在前，例如getName()，而不要nameGet()
③动词前缀往往表达特定的含义，如下表：
前缀名 意义 举例
create 创建 createOrder()
delete 删除 deleteOrder()
add 创建，暗示新创建的对象属于某个集合 addPaidOrder()
remove 删除 removeOrder()
init或则initialize 初始化，暗示会做些诸如获取资源等特殊动作 initializeObjectPool
destroy 销毁，暗示会做些诸如释放资源的特殊动作 destroyObjectPool
open 打开 openConnection()
close 关闭 closeConnection()<
read 读取 readUserName()
write 写入 writeUserName()
get 获得 getName()
set 设置 setName()
prepare 准备 prepareOrderList()
copy 复制 copyCustomerList()
modity 修改 modifyActualTotalAmount()
calculate 数值计算 calculateCommission()
do 执行某个过程或流程 doOrderCancelJob()
dispatch 判断程序流程转向 dispatchUserRequest()
start 开始 startOrderProcessing()
stop 结束 stopOrderProcessing()
send 发送某个消息或事件 sendOrderPaidMessage()
receive 接受消息或时间 receiveOrderPaidMessgae()
respond 响应用户动作 responseOrderListItemClicked()
find 查找对象 findNewSupplier()
update 更新对象 updateCommission()
find方法在业务层尽量表达业务含义，比如 findUnsettledOrders()，查询未结算订单，而不要findOrdersByStatus()。 数据访问层，find,update等方法可以表达要执行的sql，比如findByStatusAndSupplierIdOrderByName(Status.PAID, 345)
————————————————
版权声明：方法名部分为CSDN博主「小红威武」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/HongEnIT/article/details/53466278

5、静态常量

①必须全部大写，单词与单词之间用“_”隔开

6、注释

6.1 哪些部分需要注释

①java文件：版权信息、创建时间、创建人
②类：目的、所完成的功能、版权信息、创建人
③方法：参数含义、返回值
④属性：字段描述
⑤接口：目的、创建人、版本号、创建时间
⑥全局变量：字段描述

6.2 注释规范

①单行注释：//注释内容，一般与代码后空4-8格，注释必须对齐
②块注释：/注释内容/
③文档注释：
/**
*注释内容
*/

6.3 注释标签

@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向，也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明

二、建议规范部分

此部分只是建议这样做，使代码更好看

1、运算符号

“=”、“+”、“-”、“*”、“/”、“&&”、“||”等运算符号左右两边都打上空格，例如：a = 1;

2、逗号

逗号后面加空格，例如：add(1, 2)

感谢阅读

这些规范只是一部分，后续会积累添加修改，同时也欢迎大家投稿，以及有错误的部分可以指出，共同学习，一起进步。