其中java注释包括单行注释和多行注释以及文档注释

单行注释和多行注释

单行注释主要使用 "//"这个符号进行注释
多行注释则需要这样,如下

/*
这里的内容全部是多行注释
Java语言真的很有趣
*/

在我的学习资料中提到了,添加注释是每一个程序员必须所养成的习惯,这将方便于在你以后的开发学习中。同样Java注释还可以调试程序等等。

文档注释

主要命令

javadoc 选项 Java源文件|包

Java语言中还有一种文档注释,通过javadoc命令可以直接将源代码中的注释提取成一份系统的API,这对于以后开发大型软件时有很大帮助。我所学习的是Java11,Java的每个版本都自带基础类的API文档,我把链接放在下方,方便以后学习和利用。
以下是我把书中的实例搬了下来
JavadocTest.java
08302250.png

Test.java
08302251.png

以上包含了对类、构造器、成员变量的文档注释
运行以下命令便可以生成API文档了

javadoc -d apidoc -windowtitle 测试 -doctitle 学习javadoc工具的测试API文档 -header 我的类 *Test.java 

其中
-d:该选项指定一个路径,用于将生成的API文档放到指定目录下
-windowtitle:该选项指定一个字符串,用于设置API文档的浏览器窗口标题
-doctitle:该选项指定一个HTML格式的文本,用于指定概述页面的标题
-header:该选项指定一个HTML格式的文本,包含每个页的页眉
如果还想知道更多选项可以使用javadoc -help

这是执行命令后生成的HTML
6S{4_}GEGIRNRS48IAGW{7R-迅捷压缩.png

Java中还包含了相应的文档标记
@author:指定Java程序的作者
@version:指定源文件的版本
@deprecated:不推荐使用的方法
@param:方法的参数说明信息
@return:方法的返回值说明
@exception:抛出异常的类型

最后在这里补充一点东西,学习Java少用市面上的IDE,尽量手打代码,不要借助工具,推荐几个实用的软件

Editplus:editplus_v5.3.0.3248.zip

Java官方API文档:https://www.apiref.com/java11-zh/index.html

最后修改:2020 年 08 月 31 日 08 : 44 PM
如果觉得我的文章对你有用,请随意赞赏