Java注释 - 芒果文档

📌 相关文章

📜 Java注释

📅 最后修改于: 2020-02-14 12:46:39 🧑 作者: Mango

在程序中，注释通过解释所涉及的代码的目的或思想，来使程序变得更易于阅读，并且注释的正确使用使维护更加容易，并且易于发现错误。编译代码时，编译器将忽略注释。
在Java中，注释分为三种：

单行注释。
多行注释。
文档注释。

单行注释

初学者级程序员大多使用单行注释来描述代码功能。它是最容易输入的注释。
语法：

//这是一个注释，本行所有的内容在编译器看来都是注释

例：

//Java代码展示单行注释
class Scomment
{
    public static void main(String args[])
    {
         // 单行注释
         System.out.println("单行注释在上面");
    }
}

多行注释

要在代码中描述完整的方法或在复杂的代码段中写单行注释可能会很麻烦，因为我们必须在每一行都加上“ //”。因此，为了克服这种多行注释，可以使用。

/*注释开始
continues
continues
.
.
.
注释结束*/

例：

//Java程序展示多行注释
class Scomment
{
    public static void main(String args[])
    {
        System.out.println("多行注释如下");
        /*Comment line 1
          Comment line 2
          Comment line 3*/
    }
}

我们还可以使用以下语法来完成单行注释，如下所示：

/ *注释行1 * /

文档注释

在为项目/软件包编写代码时，通常使用这种类型的注释，因为它有助于生成文档页面以供参考，该页面可用于获取有关当前方法及其参数等的信息。很多Java的在线文档，是自动生成的文档页面，该页面是通过使用文档注释和用于处理注释的Javadoc工具生成的。
语法：

/ **评论开始
*
*标记用于指定参数
*或方法或标题
*也可以使用HTML标记
*例如
*
*评论结束* /

可用的标签：

标签	描述	语法
@author	添加课程的作者。	@author name-text
{@code}	以代码字体显示文本，而不将其解释为HTML标记或嵌套的Javadoc标记。	{@code text}
{@docRoot}	表示从任何生成的页面到生成的文档的根目录的相对路径。	{@docRoot}
@deprecated	添加一条注释，指示不应再使用此API。	@deprecated deprecatedtext
@exception	将Throws子标题添加到生成的文档中，并带有类名和描述文本。	@exception class-name description
{@inheritDoc}	从最近的可继承类或可实现接口继承注释。	继承直接的超级类的注释。
{@link}	插入带有可见文本标签的嵌入式链接，该链接指向指定包，类或所引用类的成员名称的文档。	{@link package.class#member label
{@linkplain}	与{@link}相同，除了链接的标签以纯文本而非代码字体显示。	{@linkplain package.class#member label}
@param	将具有指定参数名称的参数，后跟指定说明的参数添加到“参数”部分。	@param parameter-name description
@return	在说明文字中添加“返回”部分。	@return返回说明
@see	添加带有链接或文本条目的“另请参见”标题，以指向参考。	@see reference
@serial	在文档注释中用于默认可序列化字段。	@serial field-description \| include \| exclude
@serialData	记录由writeObject()或writeExternal()方法写入的数据。	@serialData data-description
@serialField	记录一个ObjectStreamField组件。	@serialField field-name field-type field-description
@since	在生成的文档中添加带有指定的since-text的“ Since”标题。	@since release
@throws	@throws和@exception标记是同义词。	@throws class-name description
{@value}	在静态字段的文档注释中使用{@value}时，它将显示该常量的值。	{@value package.class＃field}
@version	使用-version选项时，将带有指定版本文本的“版本”子标题添加到生成的文档中。	@version version-text

//Java程序，展示经常使用的注释tag
/**
* 找到三个数的平均数!
*  FindAvg计算了三个数的平均数
*  同时打印出来
*.
*
* @author  东东
* @version 1.0
* @since   2021-02-18
*/
public class FindAvg
{
    /**
    * 此方法计算三个数的平均
    * @param numA FindAvg第一个参数
    * @param numB  FindAvg第二个参数
    * @param numC  FindAvg第三个参数
    * @return int 返回numA, numB and numC的平均
    */
    public int findAvg(int numA, int numB, int numC)
    {
        return (numA + numB + numC)/3;
    }
    /**
    * main函数调用FindAvg
    * @param 参数.
    * @return 无.
    */
    public static void main(String args[])
    {
        FindAvg obj = new FindAvg();
        int avg = obj.findAvg(10, 20, 30);
        System.out.println("求平均 10, 20， 30 :" + avg);
    }
}

输出：

求平均 10, 20， 30 :20

对于以上代码，可以使用工具“ Javadoc”生成文档：
可以通过在终端中运行以下命令来使用Javadoc。

javadoc FindAvg.java

* *评论结束* /

找到三个数的平均数!

`* 评论结束 /`