注释
一、注释
- 代码量很少的时候,我们很容易看懂自己的写的代码,但是当项目结构复杂的时候,就需要用到注释了。
- 注释不会被执行,它是我们写代码的人看的。
- 平时写代码养成写注释是一个非常好的习惯,尤其复杂功能通过注释拆分任务,这样写代码会降低难度。
二、注释类型
1、单行注释:只能注释一行文字,格式://
2、多行注释:可以注释一段文字,格式: /* 注释内容 */
3、Javadoc文档注释:可以对文档,方法等进行注释,格式:/** 内容 */
三、生成Javadoc文档
1、使用命令生成Javadoc文档
格式:javadoc -encoding utf-8 -charset uft-8 filename.java
例如:javadoc -encoding utf-8 -charset uft-8 CommentTest.java
执行命令完成以后生成的文档:
打开index.html,展开类CommentTest,可以看到生成的文档效果
2、使用IDE生成Javadoc文档
第一步,选择tools-》generate JavaDoc
第二步,进行配置
第三步,点击OK
生成完成以后,如果无错误,会直接打开index.html文件,如果有错控制台会进行展示。
index.html的内容如下
出现错误的情况,例如:
欢迎批评指正,提出问题,谢谢!