Java代码规范

Java代码规范

1. 类、方法注释要以javadoc方式写
2. 非Java Doc的注释是给代码维护者看的，着重告诉读者为什么这样写，如何修改，注意什么问题等
3. 使用tab操作，实现缩进，默认整体向右边移动，使用shift+tab可以整体向左移
4. 运算符和=两边习惯性加空格
5. 源文件用utf-8编码
6. 行宽不超过80字符
7. 代码编写次行风格和尾行风格

Java注释

单行注释和多行注释

• 单行注释使用“//”

• 多行注释使用“/* */”

文档注释

文档注释可以通过JDK提供的javadoc工具可以直接将其提取成一份API文档

javadoc命令常用参数

• -d <directory>：该选项指定一个路径，将生成的API文档放入该目录下
• -windowtitle<text>：该选项指定一个字符串，用于设置API文档的浏览器窗口标题
• doctitle<html-code>：该选项指定一个HTML格式文本，用于指定概述页面的标题（处于多个包下的源文件生成的API文档时，才有概述页面）
• -header<html-code>：该选项指定一个HTML格式文本，每个页面包含页眉

Javadoc常用标记

• @author:指定Java程序作者
• @version：指定源文件版本
• @deprecated：不推荐使用的方法
• @param：方法参数的说明信息
• @return：方法的返回值说明信息
• @see：“参加”，用于指定交叉参考的内容
• @exception：抛出异常的类型
• @throws：抛出的异常，于exception同义