学习《零基础Java从入门到精通》_3.3 Java基础语法

【摘要】 本书摘自《零基础Java 从入门到精通》一书中第三章，第3节，编者是零壹快学

○3.2 注释及使用场景

在程序设计语言中，注释是用来提高程序的可读性的，好的注释和文档在很长时间后仍能清 楚地告诉他人程序的使用方法和作用。

Java有两种注释风格，分别是多行注释和单行注释。多行注释一般用于大段文本，以“/*”为 开头，中间是注释内容，以“*/”为结尾，内容可跨越多行，中间跨越的行以“*”为开头。单行 注释以“//”开头，直到本行结束，使用起来更方便，因而更为常用。

动手写3.2.1

很多IDE都支持快捷键直接创建注释或消除注释，如Eclipse中多行注释创建或消除的快捷键为 “Ctrl+Shift+/”，单行注释快捷键为“Ctrl+/”。

3.2.1 注释文档

注释文档以“/**”为开头，以“*/”为结尾。和多行注释不同的是，注释文档一般在类声 明、类的方法声明前。Java提供了javadoc将这些注释提取出来，自动生成相当好的程序文档以供参 考，输出的文档为HTML文件，可以用Web浏览器查看。这样，javadoc就将代码和文档一同维护起 来，大大降低了程序的维护成本。

动手写3.2.2

基 础 Java 从入门到精通

3.2.2 嵌入HTML语言和标签

由于Java使用注释编译器javadoc生成HTML文档进行管理，注释里也可以加入HTML代码，使 代码格式变得更加清晰明了。代码中类、方法等类型的注释文档都支持嵌入HTML语言。

动手写3.2.3

HTML语法具体可以参考本系列丛书中的《零基础HTML+CSS从入门到精通》。除了HTML语 言的嵌入，Java还提供了一些便于代码阅读的javadoc标签，如表3.2.1所示。

表3.2.1 常见的javadoc标签

标签 说明

@see 引用其他类的文档

{@link} 使用标签作为超链接到其他类的文档

{@docRoot} 文档根目录的相对路径

{@inheritDoc} 从该类最接近的基类中继承相关的文档

@version 版本说明相关信息

@author 作者信息

@since 程序最早使用的JDK版本

第 3 章 Java基础语法

（续上表）

标签 说明

@param 用于方法文档，标识方法参数

@return 用于方法文档，标识返回值内容

@throws 用于方法文档，标识抛出的异常说明

@Deprecated 标识一些旧的特性或已不再维护的代码

Java进行编译时，注释的所有内容都会被忽略，同时，在多行注释中也可以嵌入单行注释。好 的注释能够方便阅读和理解， 但是需要注意， 不好的注释会造成不必要的困扰，加大代码维护成 本，所以要在适当的地方使用正确的注释和语义，这对于初学者帮助很大。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们 18664393530@aliyun.com 处理，核实后本网站将在24小时内删除侵权内容。