Java注释

最新推荐文章于 2025-06-30 19:02:33 发布

翻译最新推荐文章于 2025-06-30 19:02:33 发布 · 303 阅读

文章标签：

#java

Java之路专栏收录该内容

2 篇文章

订阅专栏

本文介绍了Java编程语言中的注释方式，包括单行注释、多行注释和文档注释，并详细阐述了如何使用这些注释来提高代码的可读性和可维护性。此外，还提出了一些关于编写注释的最佳实践。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

关于注释，有一个笑话：
最讨厌自己写代码的时候写注释，最讨厌别人的代码不写注释

为什么写注释？
代码迁移或者改造的时候，如果面对一堆没有注释的代码，相信我，你会头大的。而且代码中有的地方会存在逻辑的转折，加入没有注释，实在是比较难以理解（就算是你自己前一段时间刚刚写过的代码）还有就是对于没有文档或者文档不全的项目，只能直接看代码，加入关键地方有几行注释，会对阅读代码的人带来极大的便利。

Java里面提供三种注释的方式：单行注释、多行注释以及文档注释
单行/多行使用‘//’注释：
使用ctrl+/来注释代码：

//  int[] data = new int[10];
//  for(int i = 0; i < data.length; i++){
//      data[i] = i;
//  }

多行使用'/**/'注释：
使用ctrl+shift+/来注释代码：

/*String[] array = new String[5];
for(int j = 0; j < array.length; j++){
    array[j] = "" + j;
}*/

文档注释：
java提供了一种强大的注释功能：文档注释，如果编写java源代码的时候添加了文档注释，通过JDK的javadoc工具就可以直接将代码里的注释提取为一份系统的API文档，其注释的格式为"/** */"

文档注释示例：

 /**
     * Initializes a newly created {@code String} object so that it represents
     * the same sequence of characters as the argument; in other words, the
     * newly created string is a copy of the argument string. Unless an
     * explicit copy of {@code original} is needed, use of this constructor is
     * unnecessary since Strings are immutable.
     *
     * @param  original
     *         A {@code String}
     */

注释的一般原则：
1.注释准确简洁
内容简单明了、含义准确, 尽量用最少的语言把问题阐述清楚, 防止注释的多义性,错误的注释不但无益反而有害.
2.避免复杂注释
如果需要用复杂的注释来解释代码, 请检查此代码是否应该重写. 尽一切可能不注释难以理解的代码, 最好选择重构.
3.TODO List
为尚未完成的代码添加TODO注释, 提醒自己还需后续完善.
4.注释形式统一
在整个项目中,使用一致的结构样式来构造注释.
5.注释与代码同步更新
写代码的时候同步书写注释，避免忘记写甚至可能补写注释的时候忘记原本的逻辑