单行注释、多行注释与文档注释的合理使用
单行注释、多行注释与文档注释的合理使用
单行注释：// 注释内容
多行注释：/ 注释内容/
文档注释：/* 注释内容 / （它是java语言特有的注释，其中的注释内容可以被JDK提供的工具 javadoc 所解析，生成一套能够以网页形式体现程序的说明文档）
区别：多行注释不可以生成开发者文档，而文档注释可以生成开发者文档（文档分为使用者文档和开发者文档）。
注意规范点：
1、三种注释都可以出现在程序的任何地方，但是一般要有个规范的地方，不推介任意找位置。
2、单行注释一般写在语句的后面。
3、多行注释和文档注释一般写在语句的上面。
4、文档注释只能出现在类、属性、方法的上面，否则提取不到。
5、多行注释中可以嵌套单行注释，多行注释中不能嵌套多行注释。
文档注释的使用（如果一个类想要使用javadoc工具生成开发者文档，那么这个类必须使用public修饰）：
在已经成功安装jdk并已经配置好path环境变量的前提下
使用dos命令：
使用 javadoc 开发工具生成，在命令行下输入javadoc会有一些javadoc使用说明可以看到。我们使用javadoc -d命令，使用格式：javadoc -d 存放路径 java源文件
网友评论