java的三种注释区别

注释

注释的分类

  1. 单行注释 符号: //

  2. 多行注释 符号 :/* */

  3. 文档注释 符号:/** */

注释之间的区别

单行注释顾名思义只能注释掉一行代码。多行注释可以注释掉多行代码。多行注释之间不能嵌套使用,但多行注释中可以有单行注释,但这貌似是脱裤子放屁-----多此一举。这两个注释在编译期间会被忽略

单行注释主要应用在只有一行需要注释的的地方,多行注释应用在多行需要注释的地方

// 这是一行单行注释
​
/*
    这是第一行注释代码
    这是第二行注释代码
*/

文档注释不会被忽略,使用命令javadoc命令编译会生成根据自己的注释对代码的说明文档,不能嵌套使用。具体javadoc命令的使用可以在命令行中输入javadoc -help查看 eg:

文档注释主要应用在对代码的一些描述,代码块所实现的功能以及一些必要说明

 /**
     * 这是一个文档注释 
     * @param catId
     * @return
     */

上一篇:包机制,JavaDoc


下一篇:JavaDoc开发文档