3.2 JAVA的注释风格
为了方便以后的维护,我们希望在源代码中加入注释。其实,在源代码中写上好的注释,是一个良好的开发习惯。一方面,注视可以帮助自己或者他人能更好地理解源代码/代码段的用途,使用条件,使用方法,结果等;另一方面,便于以后的系统维护和升级等。
Java语言使用的注释除了两种和C++的一致,还有自己特定的注释方式。
1、单行注释 "//"
// 注释一行
2、多行注释
以"/*"开始,以"*/"结束,中间的部分都是注释的内容。
3、文档注释
文档化注释也称Javadoc注释。
采用这种方法的注释,可以采用javadoc命令或工具抽取源文件里的Javadoc注释,生成组织有序的帮助文档(HTML格式的文件)。
Java注释例子:
/**
* Javadoc注释方法:
* 这是一个Java Hello world!的程序
* <p>
* 可以打印Java Hello World!
* @author summer
* @version 1.0.1, 2009-01-05
*/
public class HelloWorld{
/*
* 段落注释方法:
* main()方法
*/
public static void main(String [] args) {
//行注释方法
//打印语句
System.out.println("Hello world!"); //行注释:打印语句
}
}
* Javadoc注释方法:
* 这是一个Java Hello world!的程序
* <p>
* 可以打印Java Hello World!
* @author summer
* @version 1.0.1, 2009-01-05
*/
public class HelloWorld{
/*
* 段落注释方法:
* main()方法
*/
public static void main(String [] args) {
//行注释方法
//打印语句
System.out.println("Hello world!"); //行注释:打印语句
}
}
javadoc 标记有如下:
标识 | 用于 | 作用 |
@author | 对类的说明 | 标明开发该类模块的作者 |
@version | 对类的说明 | 标明该类模块的版本 |
@see | 对类、属性、方法的说明 | 参考转向,也就是相关主题 |
@param | 对方法的说明 | 对方法中某参数的说明 |
@return | 对方法的说明 | 对方法返回值的说明 |
@exception | 对方法的说明 | 对方法可能抛出的异常进行说明 |