本文共 626 字，大约阅读时间需要 2 分钟。
Java注释的三种类型及注意事项
Java编程中注释是理解代码、维护代码以及文档编写的重要工具。以下是三种主要的注释类型及其使用场景：
单行注释：// xxx
单行注释是最常用的注释形式，适用于对一行代码或一段逻辑进行简要说明。其特点是以 "//" 开头，后面紧跟注释内容。例如：System.out.println("Hello World!"); // 输出Hello World!多行注释：/* ... */
多行注释用于对多行代码进行注释，特别适用于复杂的逻辑或需要详细说明的代码段。注释内容可以跨越多行，直到遇到与 "//" 不同的注释符号或另一个多行注释的结束标记。例如：/* 计算客户总额并减去折扣 但注意：折扣不能超过原价的一半 如果客户级别特殊，折扣额外减半 */
文档注释：/** ... /文档注释（Javadoc）主要用于生成API文档，描述类、方法、字段等的详细信息。其格式要求注释内容必须以 /* 开头，并以 */ 结束，且每段注释前后要有空行。例如：
/** * 计算客户总额 * @param total 总金额 * @param discount 折扣率（百分比） * @return 总金额减去折扣后的金额 */
需要注意的是，书写格式方面，推荐单行注释的时候“//”与后面的注释内容之间要有且只有一个空格。这种格式既简洁又符合开发习惯，容易让其他开发者快速理解代码。
转载地址：http://gffo.baihongyu.com/