Java注释详解

Java注释详解在编写程序时,经常需要添加一些注释,用以描述某段代码的作用。一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的1/3以上。因此,注释是程序源代码的重要组成部分,一定要加以重视哦!Java中注释有三种类型:单行注释、多行注释、文档注释我们可以通过 javadoc 命令从文档注释中提取内容,生成程序的API帮助文档。打开首

大家好,欢迎来到IT知识分享网。

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

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

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

Java注释详解

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

Java注释详解

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

Java注释详解

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

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

       @version 标明该类模块的版本

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

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

       @return 对方法返回值的说明

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

免责声明:本站所有文章内容,图片,视频等均是来源于用户投稿和互联网及文摘转载整编而成,不代表本站观点,不承担相关法律责任。其著作权各归其原作者或其出版社所有。如发现本站有涉嫌抄袭侵权/违法违规的内容,侵犯到您的权益,请在线联系站长,一经查实,本站将立刻删除。 本文来自网络,若有侵权,请联系删除,如若转载,请注明出处:https://yundeesoft.com/12017.html

(0)
上一篇 2024-03-18 08:45
下一篇 2024-03-18 12:00

相关推荐

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注微信