java注释

一、代码注释的好处:

如果在源代码中加入/**.....*/开始的注释,那么就可以很容易的生成一个很有专用水准的文档。 如:javadoc就是使用此法,有源文件生成的一个HTML文档。

二、代码注释技巧:


1、每个/**......*/文档注释在标记之后紧跟着自由格式文本,标记由@开始,如:@author或@param。

2、类注释:必须放在import语句之后,类定义之前。

3、方法注释:每个方法注释必须放在所描述的方法之前。

你可能感兴趣的:(java)