事业 - 最佳实践 - 编码 - 源代码文件组织
《事业-最佳实践-编码》系列
原则
风格统一
轮廓清晰
步骤
代码文件头
版权和许可声明(可选);
命名空间(package);
外部依赖(import)
类的规范
类的声明
类的内部代码结构
类的属性;
构造方法;
工厂方法;
其他方法。
方法的代码结构
方法的规范;
方法的声明;
方法的实现。
限定词推荐使用顺序
public/private/protected (访问控制限定词,制定访问权限)
abstract (抽象类或者抽象方法,具体实现由子类完成)
static (静态类、方法或者类属性)
final (定义不能被修改的类、方法或者类属性)
transient(定义不能被序列化的类属性)
volatile(定义使用主内存的变量)
default(声明缺省的方法)
synchronized(声明同步的方法)
使用空行分割代码块
-
版权声明: 本文为 InfoQ 作者【南山】的原创文章。
原文链接:【http://xie.infoq.cn/article/17a066175e21764dde72e82fc】。
本文遵守【CC-BY 4.0】协议,转载请保留原文出处及本版权声明。
评论