JAVA代码书写规范总结

86 阅读 0 评论 57 点赞

我是靠谱客的博主冷艳金毛，最近开发中收集的这篇文章主要介绍JAVA代码书写规范总结，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

##第五章、 JAVA代码书写规范总结

**
摘要
这是接着前面四章的第五章，很多人不重视代码的规范，但是你要知道一个完整的大型项目的开发不是一个人可以完成的，所以就可以知道代码的规范是很重要的，下面呢我只做一个总结。
还想说的一句就是：如果你感兴趣，想跟着一直学，那么你就可以关注并且点赞了。我后面的章节会一步步的讲述Java，直到可以拿到8k薪资左右的程度。

命名规范
- 一般概念
  - 尽量使用完整的英文描述符（如果英文不好可以用拼音代替，一定不要用拼音首字母简称，别人是看不懂的）
  - 采用驼峰命名法使名字可读，比如yue，中文拼音下可以理解为余额，也可理解为月。yuE。
  - 尽量少用缩写，但如果用了，必须符合整个工程中的统一定义
  - 避免使用长的名字（小于 15 个字母为正常选择）
  - 避免使用类似的名字，或者仅仅是大小写不同的名字
  - 避免使用下划线（除静态常量等）
- 标识符类型说明
  - 包（ Package ）的命名：Package 的名字应该采用完整的英文描述符，都是由一个小写单词组成。并且包名的前缀总是一个顶级域名，通常是 com、edu、gov、mil、net、org 等，一般java Web项目中用com；如： com.yjhmily.test。
  - 类（ Class ）的命名:类名应该是个一名词（n代表名词，v代表动词，adj代表形容词），采用大小写混合的方式，每个单词的首字母大写。尽量保证类名简洁而富于描述。使用完整单词，避免缩写词 ( 除非工程内有统一缩写规范或该缩写词被更广泛使用，像 URL ， HTML),如： FileDescription。
代码编写风格
- 格式必须缩进对齐（缩进一定不要用空格键，必须用Tab键缩进一次）:
  
  public class AAA {
  //每一个{}下代码必须缩进一个TAB的距离，每一行代码块最后是一个{
  public static void main(String[] args) {
  for (int i = 0; i < args.length; i++) {
  for (int j = 0; j < args.length; j++) {
```
}
}
}//结束}括号必须与代码块开始对齐
```
  }
- 行宽：一行尽量不要超过80列。许多终端一个屏幕只能显示80列。如果你的语句太长，想办法折断它，分几列来写。
  
  public static void main(String[] args) {
  String str = “123qweqweasdasafqwe在线充值341231231” +
  “231231231231231231231231231231231231231”;
  }
变量命名一些普遍遵守的规范
- 用有意义的名字命名变量：首先，用完整的英语单词或约定俗成的简写命名你的变量，如：firstName、zipCode。如果英语不够好，至少用别人看得懂的拼音命名，如zhuZhi (住址）。胡乱简写，或者胡乱命名，则没有人看得懂你的变量的含义：fn、zc、zz。
- 用复数命名collection类变量：collection包括数组，vector等。命名时请用复数：customers、classMates也可以用一些修饰词命名：someStudents、allDepartments。
- 循环变量：一般大家都用i, j, k, l, m, n…等做循环变量。
- 变量的命名习惯:这里提供一个Hungarian Notation的前缀命名习惯：int–i、byte–b、char–c、double–d、float–f、long–l、offset–off、length–len、Object–o、String–s (or str)、value–v。
注释规则：
1. 每一个变量后面必须要注释此变量名的中文释义。使用//或者/**/都可以
2. 在一些复杂的结构中也需要注释。比如if条件、循环等。
3. 在类名的上面要注释此类名的意义。使用/** */。