java编码规范
2022-05-06 16:38:55 0 举报AI智能生成
java编码规范
作者其他创作
大纲/内容
基本
超过2000行的程序难以阅读
开头注释
类名、版本信息、日期和版权声明
/**
* Class Name
*
* Version information
*
* Date
*
* Copyright notice
*/
包和引入语句
package sample.android;
import java.util.Formatter;
类和接口声明
类/接口文档注释(/**……*/)
类/接口实现的注释(/*……*/)
常量
类的(静态)变量
public变量
protected变量
default变量
private变量
实例变量
private变量
default变量
protected变量
public变量
构造器
方法
这些方法应该按功能，而非作用域或访问权限，分组
为了更便于阅读和理解代码
编排缩进
4个空格作为一个缩进单元
行长度
避免超过80字符
换行
在一个逗号后面断开
在一个操作符前面断开
如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格
注释
实现注释(implementation comments)
使用/*...*/和//界定
注释的风格
块(block)
对文件，方法，数据结构和算法的描述
单行(single-line)
短注释可以显示在一行内
尾端(trailing)
应该有足够的空白来分开代码和注释
多个短注释 应该具有相同的缩进
行末(end-of-line)
注释界定符"//"
用来注释掉连续多行的代码段
文档注释(document comments)
通过javadoc工具转换成HTML文件
由/**...*/界定
一个注释对应一个类、接口或成员
javadoc只能为public（公共）和protected（受保护）成员处理注释文档
使用HTML语言标记
针对参数、返回值以及违例标记
子主题 1
@param 参数名 说明
@return 说明
@exception 完整类名 说明
声明
一行一个声明
尽量在声明局部变量的同时初始化
只在代码块的开始处声明变量
方法与方法之间以空行分隔
语句
if else语句
for语句
while和do while语句
switch语句
try catch语句
空白
空行
空格
一个紧跟着括号的关键字应该被空格分开
空格不应该置于方法名与其左括号之间。这将有助于区分关键字和方法调用
空白应该位于参数列表中逗号的后面
命名规则
包(Packages)
全部小写
域名反过来
类(Classes)
名词
大小写混合
接口(Interfaces)
大小写规则与类名相似
方法(Methods)
动词
大小写混合
第一个单词的首字母小写
变量(Variables)
除了变量名外，
所有实例，包括类，类常量，均采用大小写混合的方式，
第一个单词的首字母小写，其后单词的首字母大写
实例变量(Instance Variables) 前面需要一个下划线
常量(Constants)
应该全部大写，单词间用下划线隔开
编程惯例
避免用一个对象访问一个类的静态变量和方法
若没有足够理由，不要把实例或类变量声明为公有
若类仅作为数据结构，类似struct，则实例变量声明为公有
java代码范例
0 条评论
下一页
