美文网首页
java编码规范

java编码规范

作者: torres9gogogo | 来源:发表于2017-01-20 10:23 被阅读28次

#文件名
源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java。
#编码方式
UTF-8
#结构
一个源文件包含(按顺序地):
许可证或版权信息(如有需要)
package语句
import语句
一个顶级类(只有一个)
***以上每个部分之间用一个空行隔开。
#package
(即package语句写在一行里)
#import
不要出现类似这样的import语句:import java.util.*;
(每个import语句独立成行)
import语句可分为以下几组,按照这个顺序,每组由一个空行分隔:
所有的静态导入独立成组
com.google imports(仅当这个源文件是在com.google包下)
第三方的包。每个顶级包为一组,字典序。例如:android, com, junit, org, sun
java imports
javax imports
组内不空行,按字典序排列。
#类声明
3.4.1 只有一个顶级类声明
每个顶级类都在一个与它同名的源文件中(当然,还包含.java后缀)。
例外:package-info.java,该文件中可没有package-info类。
3.4.2 类成员顺序
类的成员顺序对易学性有很大的影响,但这也不存在唯一的通用法则。不同的类对成员的排序可能是不同的。 最重要的一点,每个类应该以某种逻辑去排序它的成员,维护者应该要能解释这种排序逻辑。比如, 新的方法不能总是习惯性地添加到类的结尾,因为这样就是按时间顺序而非某种逻辑来排序的。
3.4.2.1 重载:永不分离
当一个类有多个构造函数,或是多个同名方法,这些函数/方法应该按顺序出现在一起,中间不要放进其它函数/方法。
#大括号
4.1.1 使用大括号(即使是可选的)
大括号与if, else, for, do, while语句一起使用,即使只有一条语句(或是空),也应该把大括号写上。
4.1.2 非空块:K & R 风格
对于非空块和块状结构,大括号遵循Kernighan和Ritchie风格 (Egyptian brackets):
左大括号前不换行
左大括号后换行
右大括号前换行
如果右大括号是一个语句、函数体或类的终止,则右大括号后换行; 否则不换行。例如,如果右大括号后面是else或逗号,则不换行。
示例:

return new MyClass() {
  @Override public void method() {
    if (condition()) {
      try {
        something();
      } catch (ProblemException e) {
        recover();
      }
    }
  }
}; 

相关文章

  • 编码规范(一)越是建议的编码规范越会令团队纠结

    所属文章系列及序号:寻找尘封的银弹:编码规范(一) 我见过很多编码规范,例如C++编码规范、Java编码规范、C+...

  • Java代码规范

    遵从java编码规范,目的做到代码规范、统一 鲁曾说过:只要代码规范了工作就完成了一半。。。 0.遵从java编码...

  • Android 开发规范

    前言 本文参考Google Java编程规范和阿里巴巴Java规范,Android编码规范部分参考Android开...

  • Java编码规范

  • java编码规范

    #文件名源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java。#编码方式UTF-8#结构一个源文件包含...

  • Java编码规范

    Java 代码规范 本 Java 代码规范以 SUN 的标准 Java 代码规范为基础,为适应我们公司的实际需要,...

  • Java编码规范

    介绍 本文档以SUN的标准Java代码规范为基础,结合公司的实际需要,做一些修改和补充,编写次文档的目的是规范公司...

  • Android 代码命名规范

    前言 根据 Google Java 编程规范 & Google 官方 Android 编码规范,整理一份全面 & ...

  • 分享|阿里官方Java代码规范标准《阿里巴巴Java开发手册》

    阿里巴巴Java开发手册,首次公开阿里官方Java代码规范标准。 这套Java统一规范标准将有助于提高行业编码规范...

  • 前端开发文档规范

    HTML 编码规范 请查看HTML编码规范 CSS 编码规范 请查看CSS编码规范 JavaScript 编码规范...

网友评论

      本文标题:java编码规范

      本文链接:https://www.haomeiwen.com/subject/dvywbttx.html