注释
注释就是使用文字对程序的说明,注释是写给程序员看的,编译器会忽略注释的 内容的。
1 单行注释
第一种: 单行注释。 // 注释的内容
2 多行注释
第二种: 多行注释。 / 注释的内容 /
3 文档注释
第三种: 文档注释. /* 注释的内容 /
注释要注意的细节:
单行注释可以嵌套使用,多行注意是不能嵌套使用的。
注释的作用:
- 使用文字对程序说明。
- 调试程序。
多行注释与文档注释的区别:
多行注释的内容不能用于生成一个开发者文档,而文档注释 的内容可以生产一个开发者文档。
使用javadoc开发工具即可生成一个开发者文档。
javadoc工具的使用格式:
javadoc -d 存放文档的路径 java的源文件
例子:
javadoc -d .\doc Demo1.java
使用javadoc工具要注意细节
- 如果一个类需要使用javadoc工具生成一个软件的开发者文档,那么该类必须使用public修饰。
- 文档注释注释的内容一般都是位于类或者方法的上面的。
写注释的规范:
- 一般单行注释是位于代码的右侧
- 多行注释与文档注释一般是写在类或者方法的上面的。