如何在Java中使用注释

在编写程序时,经常需要添加一些注释,用以描述某段代码的作用。

一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的 1/3 以上。因此,注释是程序源代码的重要组成部分,一定要加以重视哦!

Java 中注释有三种类型:单行注释、多行注释、文档注释

运行结果:Hello Imooc!

看:被注释的代码块在程序运行时是不会被执行的~~

我们可以通过javadoc命令从文档注释中提取内容,生成程序的 API 帮助文档。

打开首页,查看下生成的 API 文档

PS:使用文档注释时还可以使用javadoc 标记,生成更详细的文档信息:

@author 标明开发该类模块的作者

@version 标明该类模块的版本

@see 参考转向,也就是相关主题

@param 对方法中某参数的说明

@return 对方法返回值的说明

@exception 对方法可能抛出的异常进行说明

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 136,107评论 19 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 176,280评论 25 709
  • 感受下这种新的训练模式 分为两个循环组 :CIRCUIT1和CIRCUIT2 每两个动作之间休息10秒 CIRCU...
    美美食谱阅读 3,332评论 0 0
  • 在寒冷的冬日, 我总会想起家里妈妈煮的火锅。 表皮上是飘着一些油脂的, 冒着一腾腾的热气。 沸腾的水里面夹杂着肉和...
    Runner向阳阅读 1,693评论 1 1
  • 某年的的秋天开始, 你悄悄诞生了,伴随在一阵岁月歌声里,你慢慢成长起来,一点一滴都是从父母老师那灌输而来,对世界你...
    周不到阅读 1,832评论 0 0

友情链接更多精彩内容