注释----->该怎么写/单行/多行/文档

几行代码也许很容易知道功能,但几百行的代码,多个文件,也许刚写的时候是知道功能与特性的,但是随着时间的流逝,对自己的代码越来越难以理解,更别说其他人了。代码的可读性巨差,影响编程开发效率。

注释的分类

1 单行注释://;选中要注释的代码块或者一行代码,然后按键盘“ Ctrl + shift + C ”或者“ Ctrl + / ”

  进行注释,该快捷键既可以注释单行也可以注释多行

2 多行注释:/*........*/   同上     取消注释:直接按相同的快捷键“ Ctrl + shift + C ”或者“ Ctrl + / ”

3 文档注释:/**.........*/文档注释里面还有很多其他选项,一般要通过开发工具进行控制  在对代码中文档进行注释的时候,使用快捷键“ Alt + shift + J ”

单行注释的使用场景:单行注释一般写在语句的后面。

多行注释的使用场景:一些重要代码,多行注释和文档注释一般写在语句的上面

文档注释的使用场景:文档注释只能出现在类、属性、方法的上面,否则提取不到

文档注释的使用(如果一个类想要使用javadoc工具生成开发者文档,那么这个类必须使用public修饰):

在已经成功安装jdk并已经配置好path环境变量的前提下

1、使用dos命令

使用 javadoc 开发工具生成,在命令行下输入javadoc会有一些javadoc使用说明可以看到。我们使用javadoc -d命令,使用格式:javadoc -d 存放路径 java源文件

2、eclipse

使用eclipse就没有这么些问题了,直接创建java类,然后Project-->Generate Javadoc,点击Generate Javadoc后,进入弹出的界面,选择javadoc.exe命令的位置,选择要生成Javadoc的包,或者包下的类,以及生成的Javadoc文档所存的路径,默认生成到当前工程目录下。之后会生成Javadoc文件:在生成文档的目录下会有一堆文件,找到index.html文件,打开查看具体的内容就ok。

猜你喜欢

转载自www.cnblogs.com/shitulaoma/p/12438949.html