JAVA中的注释方法

Posted 2022-11-19 r-flz-c

Java的三种注释方法

①单行注释：使用 // ，其注释内容从//开始到本行结束，比较常用，

                      快捷键为：Ctrl + / 或者  Ctrl + Shift + C 

                      取消注释：Ctrl + / 或者 Ctrl + Shift + C

②多行注释：配套使用 /* 和 */ ,可以将一段比较长的注释括起来，注意不能嵌套使用，

　　　　　　快捷键为：Ctrl  + Shift + /     

　　　　　　取消注释：Ctrl + Shift + \

③文档注释：这种注释方法以 /** 开始，以 */ 结束，

　　　　　　快捷键：Alt + Shift + J

Java文档注释详细说明

JDK包含的Javadoc工具可以有源文件生成一个HTLM文档，这种方式可以将代码与注释保存在一个地方。

1、注释的插入

　　①javadoc实用程序（utility）从以下特性抽取信息：包、共有类与接口、公有的和受保护的构造器及方法、公有的和受保护的域；

　　②应该为上面几部分编写注释，并且注释应该放置在所描述特性的前面；

　　③文档注释为 /** 开始，并以 */ 结束；

　　④每个/** ... */文档注释在标记之后紧跟着自由格式文本，标记由@开始，如@author或@param；

　　⑤在自由格式文本中，可以使用html修饰符，例如，用于强调的<em>...</em>、用于着重强调的<strong>...</strong>以及包含图像的<img ...>等，

    　　但是不能使用<h1>或<hr>，因为它们会与文档的格式产生冲突；

　　⑥在自由格式文本中，若要键入等宽代码，需使用@code ...，而不是<code>...</code>，这样避免了对代码中<字符的转义。

注：如采文档中有到其他文件的链接， 例如， 图像文件（用户界面的组件的图表或图像等）， 就应该将这些文件放到子目录 doc-files中。

       javadoc实用程序将从源目录拷贝这些目录及其中的文件到文档目录中。

       在链接中需要使用doc-files目录 ， 例如：＜img src= “doc-files/uml.png” alt＝ “ UMLdiagram ” ＞。

2、类注释

　　类注释必须放在import i再句之后， 类定义之前。

3、方法注释

　　每一个方法注释必须放在所描述的方法之前。除了通用标记之外，还可以使用下面的标记：

　　①@param变量描述

　　　　这个标记将对当前方法的“param”（参数）部分添加一个条目。这个描述可以占据多行，并可以使用HTML标记。一个方法的所有@param标记必须放在一起。

　　②@return描述

　　　　这个标记将对当前方法添加“return”（返回）部分。这个描述可以跨越多行，并可以使用HTML标记。

　　③@throws类描述

　　　　这个标记将添加一个注释， 用于表示这个方法有可能抛出异常。

4、域注释

　　只需要对公有域（通常指的是静态常量）。例如：

 

1 /**
2  * The "Hearts" card suit
3  */
4 public static final int HEARTS = 1;

域注释例子

 

5、通用注释

 

@author 姓名	作者条目
@version 文本	版本条目
@since 文本	始于条目
@deprecated 文本
@see 引用

以上内容参考《Java核心技术 卷Ⅰ》