java注释规范

在eclipse中，TODO、FIXME和XXX都会被eclipse的task视图所收集。在项目发布前，检查一下task视图是一个很好的习惯。

Window -->Show View --> Tasks

 

TODO: + 说明：

如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。

 

FIXME: + 说明：

如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。

 

XXX: + 说明：

如果代码中有该标识，说明标识处代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进，要改进的地方会在说明中简略说明。

 

// 注释一行

/* ...... */ 注释若干行

还有第三种，文档注释：

/** ...... */ 注释若干行，并写入 javadoc 文档

 

格式化文档，就是在文档注释中添加相应的 HTML 标识。

 

文档注释的三部分

* show 方法的简述.

* <p>show 方法的详细说明第一行<br>

* show 方法的详细说明第二行

第一部分是简述。

文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明。

列表中属性名或者方法名后面那段说明就是简述。

不要画蛇添足——在详细说明部分中再写一次简述哦！

第二部分是详细说明部分。

该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。

第三部分是特殊说明部分。

这部分包括版本说明、参数说明、返回值说明等。