前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Java中的三种注释类型「建议收藏」

Java中的三种注释类型「建议收藏」

作者头像
全栈程序员站长
发布2022-09-08 11:35:44
9560
发布2022-09-08 11:35:44
举报
文章被收录于专栏:全栈程序员必看

大家好,又见面了,我是你们的朋友全栈君。

注释:用于说明解释程序的文字就是注释。

Java中的注释有三种:

  • 单行注释
  • 多行注释
  • 文档注释(Java特有)

注释的作用有什么?

主要就是提高了代码的阅读性,是调试程序的重要方法。

当然,写注释也是一种良好编程习惯。可以将自己的思想通过注释先整理出来,再用代码去体现。

来看看具体的使用吧!

单行注释 格式: //注释文字

多行注释 格式: /* 注释文字 */

下面给出单行注释和多行注释的示例:

代码语言:javascript
复制
//单行注释
public class HelloWorld{ 
   
    
    /* 程序入口 */
    public static void main(String args[]){ 
   
        System.out.println("HelloWorld!");
    }
    
}

注:对于单行和多行注释,被注释的文字,不会被JVM(java虚拟机)解释执行。多行注释里面不允许有多行注释嵌套。

来试试先:

代码语言:javascript
复制
public class HelloWorld{ 
   
    
    /* 程序入口 /* 会报错吗? */
    
    */
    public static void main(String args[]){ 
   
        System.out.println("HelloWorld!");
    }
    
}

运行一下:

多行注释不能嵌套多行注释是因为在注释时,”/*” 是去匹配第一个遇到的” /”,后面的 “/”一律视为注释内容。

文档格式(Java特有) 格式:/** @author 指定java 程序的作者 @version 指定源文件的版本 */

注释内容可以被JDK提供的工具 javadoc 所解析,生成一套以网页文件形式体现的该程序的说明文档。

操作一下:

代码语言:javascript
复制
/** @author chunni @version v1.0 第一个Java程序! */
public class HelloWorld{ 
   
    
    /* 程序主入口,main函数 */
    public static void main(String args[]){ 
   
        System.out.println("HelloWorld!");
    }
    
}

命令行窗口输入:javadoc -d 生成的文件名 -author -version HelloWorld.java

此时发现原来代码目录下出现么mydoc文件夹。

点进mydoc文件夹打开index.html就可以查看doc文档了

发布者:全栈程序员栈长,转载请注明出处:https://javaforall.cn/156442.html原文链接:https://javaforall.cn

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档