关于 Java 的代码注释

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
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值