关于 Java 的代码注释

﹏ヽ暗。殇╰゛Y 2023-02-20 12:07 16阅读 0赞

**1、单行注释**  
以 // 开头， // 后面皆为注释，示例如下：

public class HelloWorld 
    { 
     public static void main(String[] args)
     { 
      System.out.println("Hello World");//输出 Hello World
     }
    }

**2、多行注释**  
以 /\* 开头，以 \*/ 结尾，*在 /* \*和 \*/ 之间的内容为注释，也可以使用多行注释作为行内注释，但多行注释不能嵌套使用。示例如下：

public class HelloWorld 
    { 
     public static void main(String[] args/* args是一个参数名*/)
     { 
      System.out.println("Hello World");
     }
    }
    /* 多行注释 */

**3、文档注释**  
以 /\*\* 为开头，以 \*/ 为结尾，注释包含一些说明性文字和JavaDoc标签，示例如下：

/** * 对整体文档的一个介绍 * @author JK * */
    public class HelloWorld 
    { 
     /** * 对方法的一个说明注释 * @param args */
     public static void main(String[] args)
     { 
      System.out.println("Hello World");
     }
    }

**4、注释的作用**  
在代码中写注释是非常有必要的，我们看 Java 源码的时候就会发现里面有非常多的注释，用于提高代码的可读性。我们所写的注释在程序编译时是不会被编译的。  
（1）当我们开发一个项目时，可能内容比较多用时比较长，当我们自己过一段时间再回头看自己写的代码时可能就不明白自己当时为什么要这样写，某一段的代码的作用是什么，所有写上注释也方便我们自己对代码的阅读。  
（2）当做一个大型项目时我们自己一个人是非常难以完成的，所以就需要团队合作，如果不对代码加上注释，其他人在看我们自己写的代码时也是非常困难和发费时间的。

发表评论取消回复

表情：

评论列表（有 0 条评论，16人围观）

还没有评论，来说两句吧...

相关阅读

相关 Java 代码注释

Java 代码注释 1 单行注释 “//”为单行注释标记，从符号“//”开始直到换行为止的所有内容均作为注释而被编译器忽略。 //注释内容例如：

妖狐艹你老母/ 2024年03月26日 16:14/ 0 赞/ 82 阅读

相关关于程序员写代码加不加注释问题的看法

程序员对代码注释可以说是又爱又恨又双标……你是怎么看待程序员不写注释这一事件的呢？分享一：我的观点和故事 > 我一般都会写，主要是方便日后自己维护，同时也方便其

落日映苍穹つ/ 2024年02月23日 08:05/ 0 赞/ 44 阅读

相关关于JavaDoc文档注释

参考文章： [https://blog.csdn.net/garfielder007/article/details/54959587][https_blog.csdn.ne

秒速五厘米/ 2023年12月15日 07:45/ 0 赞/ 226 阅读

相关关于 Java 的代码注释

1、单行注释以 // 开头， // 后面皆为注释，示例如下： public class HelloWorld { public stati

﹏ヽ暗。殇╰゛Y/ 2023年02月20日 12:07/ 0 赞/ 17 阅读

相关 JAVA适配器简单代码注释,Java适配器注释

为了设计尽可能重用的组件,我最近想到了所谓的“适配器注释”的可能性.这就是说,经典的Adapter OO模式应用于 Java注释.例如,假设我有一个完全基于JUnit的单元测

Love The Way You Lie/ 2023年01月13日 05:39/ 0 赞/ 164 阅读

相关 Elipse Java代码注释模板

编辑注释模板的方法：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素

系统管理员/ 2022年05月31日 03:20/ 0 赞/ 218 阅读

相关有趣的代码注释

``` /　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　瓦瓦　　　　　　　　　　　　十　　　　　　　　

古城微笑少年丶/ 2022年04月17日 04:35/ 0 赞/ 246 阅读

相关 intellij自动生成java代码注释(java文件注释和方法注释)

idea编辑器设置java类和方法注释自动生成参考链接： [https://blog.csdn.net/pucao\_cug/article/details/7030

偏执的太偏执、/ 2022年03月29日 12:52/ 0 赞/ 311 阅读

相关 java代码注释规范

代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。下面说一下我们在诉求网二期

灰太狼/ 2022年02月13日 16:43/ 0 赞/ 324 阅读

相关 Java代码注释

曾经我对“一份好的代码里注释至少要占到一半的份量”这样话深信不疑，我也不厌其烦的给每一个函数都加上javadoc，对此，我深感自豪；而对于别人写代码不加注释的“坏习惯”，我深表

骑猪看日落/ 2021年05月10日 11:18/ 0 赞/ 692 阅读