java中的注释可分为三种类型
发布时间:2025-05-24 07:54:26 发布人:远客网络
一、java中的注释可分为三种类型
1、代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以不是为写注释而写注释。
2、备注:简单的代码做简单注释,注释内容不大于10个字即可,另外,持久化对象或VO对象的getter、setter方法不需加注释。
3、类(模块)注释采用/**……*/,在每个类(模块)的头部要有必要的注释信息,包括:工程名;类(模块)编号;命名空间;类可以运行的JDK版本;版本号;作者;创建时间;类(模块)功能描述(如功能、主要算法、内部各部分之间的关系、该类与其类的关系等,必要时还要有一些如特别的软硬件要求等说明);主要函数或过程清单及本类(模块)历史修改记录等。
4、参考资料来源:百度百科-java注释
二、java 中的几种注释方式
我看动力节点的java基础大全301集教中的三种注释方法:
3、/**......*/,这种方式和第二种方式相似。这种格式是为了便于javadoc程序自动生成文档。
(1)javadoc针对public类生成注释文档
(2)javadoc只能在public、protected修饰的方法或者属性之上
(3)javadoc注释的格式化:前导*号和HTML标签
(4)javadoc注释要仅靠在类、属性、方法之前
下面主要举例说明第三种注释的应用:
(2)在命令行中执行以下dos命令:
javadoc*.java//根据相应的Java源代码及其说明语句生成HTML文档
//javadoc标记:是@开头的,对javadoc而言,特殊的标记。
(3)在当前目录下就会产生doc文件夹,里面有一系列的.html文件
<spanstyle="font-size:18px;">*/
publicstaticvoidmain(String[]args){
System.out.println("HelloWorld!");
/**这是第1个方法,其作用是...*/
<spanstyle="font-size:18px;">importjava.io.IOException;
*<br>链接到另一个文档{@linkHello},就这些
/**非public,protected属性上的注释不生成*/
*@paramargs用户输入的参数,是数组
*@throwsIOExceptionmain方法io异常
publicstaticvoidmain(Stringargs[])throwsIOException{
System.out.println("helloWorld!");
/**这是第一个方法,其作用是....
*@deprecated从版本1.2开始,不再建议使用此方法
/**这是第二个方法,其作用是....
publicstaticStringf2(inti)throwsIOException{
如果源文件中有用到@version,@author标记,则在执行javadoc命令时,要加-version-author
javadoc-version-author-ddoc*.java
(其中用-version用于提取源文件中的版本信息-author用于提取源文件中的作者信息)
三、请列出java中的注释
1、在Java里面主要有三种注释:行注释、段落注释、文档注释
2、1)行注释:行注释也成为单行注释,行注释使用“//注释文字”的格式来对某一行的代码进行注释或者加以说明
3、2)段注释:段注释也成为多行注释,通常是当说明文字比较长的时候的注释方法
4、3)文档注释:文档注释是Java里面的一个比较厉害的功能,它可以用于注释类、属性、方法等说明,而且通过JDK工具javadoc直接生成相关文档,文档注释的基本格式为“/**...*/”,不仅仅如此,文档注释本身还存在语法