在代码工程中,维修和精进代码是必不可少的,而此时注释便发挥了重要作用,可以节约大量的时间和人力。因此代码常常是给相关技术人员看的。
1.便于阅读 2.方便查错
1.单行注释(不会在help的文档中显示注释内容) //注释文字
2.多行注释(同样不会在help文档中显示注释内容) /* *注释 *文字 */
3.文档注释: /** *注释 *文字 */
注意:单行注释可以嵌套,但多行注释不可以嵌套
例如:
/** *文段注释 *第一个Java */ //Hello /* *World */ public class HelloWorld{ public static void main(String [] args){ int a=10,b=20; if((a=0)==0|(b=0)==0) { System.out.println(b); } System.out.println("Hello world"); } }注意:文档注释的代码的位置不一样,在文档注释中显示的位置不一样,如在代码的中间写,便显示在“方法细的main”中,若是在代码的结束后写,便没有显示。
1.操作
在Java代码所在的目录输入cmd
在命令行中输入
javadoc -d c:\help -author -version HelloWorld.java
此时可以在命令语句中找到help所在路径
其中,javadoc 表示将注释生产代码
c:\help -author -version HelloWorld.java表示文档所在路径。
2.展现
在目录里输入
c\help: -author -version HelloWorld.java
便会打开一个页面
win+E:此电脑
点击两次文档:重命名
方向键:可以直接查询命令框的命令语句
如有缺陷或者错误,请不吝赐教。