Java的三种不同注释方式

74 阅读 0 评论 49 点赞

我是靠谱客的博主健壮导师，最近开发中收集的这篇文章主要介绍 Java的三种不同注释方式，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

Java的三种不同注释方式

注释：是一种在程序源代码中插入的不影响程序运行的文字，可以在不妨碍程序运行的同时，使得代码具有更强的可读性（提前注释好代码的作用总是比看一遍代码理解其作用来的快的），既方便自己回头修改与更新代码，也方便了他人阅读读懂自己的代码，所以注释在编写代码的过程中尤为重要！！！

注释的三种不同方式：

① //.......单行注释

public class HelloWorld{
public static void main(String [] args){
System.out.println("ZZXTIT"); //This is my first java program
}
}

单行注释的最大特点就是操作简单，能快速对每行的代码进行注释文本信息，很是方便，但当所注释的内容太长则会使界面的横条拉长，查看代码或注释时需要拖动横条，非常不方便

②/*......*/多行注释, (注释内容不会被写入javadoc文档（Ctrl+Shift+/ ））


public class HelloWorld{
public static void main(String [] args){
System.out.println("ZZXTIT");
}
}
/*
*This
*my
*first
*java
*program
*/

当注释内容很多时，选用这种多行注释的方法会很方便，且这种注释方式不会被写入javadoc文档

③/**.......*/多行注释（注释内容会写入javadoc生成的文档中（Ctrl+Shift+/ ，回车））


public class HelloWorld{
public static void main(String [] args){
System.out.println("HelloWorld");
}
}
/**
*This
*is
*my
*first
*java
*program
*/

这种注释方式的作用与/*......*/基本相同，唯一不一样的地方就是注释内容不会写入javadoc文档，而/**.......*/的注释内容会写入javadoc文档

那么Javadoc文档到底是什么呢？

Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档，也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。Javadoc 命令是用来将文档注释内容生成类似 jdk 帮助文档格式的 API 文档，允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息，并输出到HTML文件中。

javadoc 工具软件识别以下标签：

标签	描述	示例
@author	标识一个类的作者	@author description
@deprecated	指名一个过期的类或成员	@deprecated description
{@docRoot}	指明当前文档根目录的路径	Directory Path
@exception	标志一个类抛出的异常	@exception exception-name explanation
{@inheritDoc}	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
{@link}	插入一个到另一个主题的链接	{@link name text}
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数	@param parameter-name explanation
@return	说明返回值类型	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过writeObject( ) 和 writeExternal( )方法写的数据	@serialData description
@serialField	说明一个ObjectStreamField组件	@serialField name type description
@since	标记当引入一个特定的变化时	@since release
@throws	和 @exception标签一样.	The @throws tag has the same meaning as the @exception tag.
{@value}	显示常量的值，该常量必须是static属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本	@version info

@version 只能用于类上注释，代码版本
@since 一般指最低支持的 jdk 版本
@exception、@throws 抛出的异常
@param 方法参数
@return 返回值
{@link} {@link 包名.类名#方法名(参数类型)} 用于快速链接到相关代码
{@value} 显示常量的值，该常量必须是static属性。
@code： {@code text} 将文本标记为code
{@code text} 会被解析成<code>text <code>
将文本标记为代码样式的文本，在code内部可以使用 < 、> 等不会被解释成html标签, code标签有自己的样式

一般在Javadoc中只要涉及到类名或者方法名，都需要使用@code进行标记。
详细描述一般用一段或者几个锻炼来详细描述类的作用，详细描述中可以使用html标签，如<p>、<pre>、<a>、<li>等标签，通常详细描述都以段落p标签开始。
详细描述和概要描述中间通常有一个空行来分割
注意：
- 当 {@link }用于连接到方法时：包名.类名#方法名(参数类型)，方法名前必须是 # 号，用法： {@link 包名.类名#方法名(参数类型)