Java注释

文
章
目
录

• 为什么要写注释？
• Java 注释的类型
• 单行注释
• 多行注释
• Java 文档注释
• Java 注释对性能的影响
• Java注释最佳实践

了解有关Java 注释、Java 注释类型、Javadoc工具、注释对性能的影响以及要遵循的最佳实践的所有内容。

为什么要写注释？

顾名思义，注释是我们出于各种原因在程序之间编写的注释。例如，您可以将评论写给 –

• 写下有关变量、方法、类或任何语句的信息或解释。
• 编写可在 Java 文档中使用的文本。
• 隐藏特定时间的程序代码等。

给定的代码是Java 注释的示例，以及如何使用它们。

主程序.java/**
 * Contains method to greet users by their name and location.
 *
 * @author Lokesh Gupta
 */
public class Main {

    /**
     * Launches the application
     *
     * @param args - Application startup arguments
     */
    public static void main(String[] args) {
        getMessage(\"Lokesh\", \"India\");
    }

    /**
     * Returns welcome message for a customer by customer name and location
     *
     * @param name - Name of the visitor
     * @param region - Location
     * @return - Welcome message
     */
    public static String getMessage (String name, String region)
    {
        StringBuilder builder = new StringBuilder();
        builder.append(\"Hello \");
        builder.append(name);
        builder.append(\", Welcome to \");
        builder.append(region);
        builder.append(\" !!\");
        return builder.toString();
    }
}

Java 注释的类型

Java 中有3 种类型的注释。

单行注释

当注释只能写在一行中时，请使用单行注释。这些注释写在 Java 语句上，以阐明它们在做什么。

// 这里是单行注释 
int counter = 0;

多行注释

当您需要在源代码中添加超过一行的信息时，请使用多行注释。多行注释多用于逻辑复杂、单行无法写出的代码块上方。

/*
 * 这是多行注释
 * 可以写多行说明
 */
public int getCounter() {
  //
}

Java 文档注释

javadoc 当您想要公开要通过阅读源代码为类创建 HTML 文档的工具获取的信息时，可以使用文档注释 。这是使用自动完成功能时在编辑器（例如 eclipse）中看到的信息  。这些注释是类、接口和方法定义上面的坑。

• 文档注释以 开头 /** 和结尾 */。按照约定，文档注释的每一行都以 开头 *，如以下示例所示，但这是可选的。* 每行上的任何前导间距和 都 将被忽略。
• 在文档注释中，以 开头的行 @ 被解释为文档生成器的特殊指令，为其提供有关源代码的信息。
•  您可以在这些注释中 使用 javadoc 注释，@param例如 和 @return。

/**
  * 这是文档注释
  *
  * @param seed 参数
  * @return counter 返回值
  */
public int getCounter(int seed) {
  //
}

文档注释可以出现在类、方法和变量定义之上，但某些标签可能不适用于所有这些。例如， @exception 标签只能应用于方法。

文档注释是编程不可或缺的一部分，不应被跳过。

Java 注释对性能的影响

Java 代码中的实现注释仅供人类阅读。Java注释是不被编译器编译的语句，因此它们不包含在编译后的字节码（.class文件）中。

这就是为什么Java 注释对应用程序性能也没有影响。

Java注释最佳实践

请遵循这些最佳实践，以便在应用程序源代码中添加适当的注释。

• 不要在源代码中使用不必要的注释。如果您的代码需要比正常解释更多的内容，那么可能需要重构您的代码。
• 保持注释缩进一致并匹配以获得最佳可读性。
• 评论是针对人类的，因此请使用简单的语言来解释。
• 始终在源代码中添加文档注释。

归属教程 Java基础教程

文章目录 前言  第1章 Java语言基础 第2章 流程控制语句 第3章 面向对象编程 第4章 Java 字符 […]