代码规范的好处 :
好的编码规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码。
好的编码规范可以最大限度的提高团队开发的合作效率。
长期的规范性编码还可以让开发人员养成好的编码习惯,甚至锻炼出更加严谨的思维。
骆驼法则:Java中,除了包名,静态常量等特殊情况,大部分情况下标识符使用骆驼法则,即单词之间不使用特殊符号分割,而是通过首字母大写来分割。比如:WriteCsdn,而不是Write_Csdn。
包名:尽量使用小写,比如com.xxx.xxx.csdn,而不要写成com.xxx.xxx.Csdn。
包名的后缀往往代表不同的涵义
Service----服务层,impl---服务实现类,Dao---是封装对数据库的访问,不涉及业务逻辑
Entity---实体层,Factory---生成某个对象的工厂类
类名:首字母大写,比如CsdnXxx
代码块格式:缩进风格:大括号的开始在代码块开始的行尾,闭合在和代码块同一缩进的行首,比如
public String getCardNoByOpenId(String openid) {
if () {
}
}
代码注释:单行使用Ctrl+/
//return personnelMapper.getCardNoByOpenId(openid);
多行使用Ctrl+Shift+/
/* String aT = WeChatApi.token.get().get("accessToken").toString();
String url = "https://api.weixin.qq.com/wxa/business/getuserphonenumber?access_token=" + aT;
//定义发送数据
JSONObject param = new JSONObject();
param.put("code", code);*/
TODO:善用TODO:在代码中加入//TODO: ,大部分的idea都会帮你提示,让你知道你还有什么事没有做。
总结:1)java对大小写敏感,严格区分大小写。
(2)每一条语句都以半角的(;)结束。
(3)一行最好只写一条语句。
(4)为程序可读性,尽可能养成加上注释习惯。
(5)尽量避免一行的长度超过80个字符,因为很多终端和工具不能很好地处理,但这一设置可以灵活进行调整。