注释内容可以被JDK提供的工具javadoc所解析,生成一套以网页文件形式体现的该程序的说明文档,一般写在类
- 基本格式
- 如何生成对应的文档注释
- 应用实例
javadoc -d 文件夹名 -xx -yy Demo3.java
javadoc标签
================================================
Java代码规范:
1.类、方法的注释,要以javadoc的方式来写
2.非java Doc的注释,往往是给代码的维护者看的 , 着重告诉读者为什么这样写,如何修改,注意什么问题等
3.使用tab操作,实现缩进,整体向右边移动的时候默认使用shift+tab整体向左移
4.运算符和 = 两边习惯性各加一个空格. 比如: 2 + 4 * 5 + 345 - 89
5.源文件使用utf-8编码
6.行宽度最好不要超过80字符
7.代码编写按照次行风格或者行尾风格
//行尾风格:
public ArrayList(int element){
if( element > 0 ){
.............
}
}
//次行风格:
public ArrayList(int element)
{
if( element > 0 )
{
..............
}
}