- 命名规范
- 变量定义
用int[] packets,永远不要用 int packets[]形式
- 代码编写
样式推荐用unix格式——回车+换行
javadoc文档化
缩进2个字符(不要用tab,避免不同的代码管理工具tab设置不同)
不加无意思的括号,{ }分两行 - 全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
- 注释规范
3种形式——// 注释一行
/*……*/ 注释若干行
/**……*/ 文档注释,写入javadoc
注释放在上方或右方
整个源文件要有详细的注释
每个函数前有必要的注释
javadoc注释标签语法:
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向,也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说
-
函数
保证每个参数的有确切含义。
exit只能在main中被调用
顶层的main应该截获所有异常,并且打印到屏幕或记录日志
如果不确定某类是否要被继承,在文档中注明,不轻易定义为final
-
*. java文件应该遵循的样式(主要包含以下部分)
版本信息放在java文件开头,形式为(其他不要出现在javadoc中内容也可以包含其中)
package放在import之前,import标准 放在 import本地 之前。
类注释
类定义
类成员变量(public 成员变量必须生成javadoc)
存取方法(如果很简单可以写在同一行)
构造函数
类方法
toString方法(每个类都应该有toString方法)
main方法(如果有main方法,应写在类的最底部)
-
注意一些性能
不要再循环中构造变量 或 释放变量
加强个人Java编程规范
最新推荐文章于 2024-07-15 22:27:18 发布