java中注释起什么作用 有哪几种 JAVA程序中注释的作用及类型分别是什么
大家好,今天给各位分享java中注释起什么作用 有哪几种的一些知识,其中也会对JAVA程序中注释的作用及类型分别是什么进行解释,文章篇幅可能偏长,如果能碰巧解决你现在面临的问题,别忘了关注本站,现在就马上开始吧!
JAVA中 注释行做什么用的
简单的说
注释是一种良好变成习惯用于解释您的程序含义
有//单行注释有/**/多行注释有/***/多行注释会保留三种
大型程序代码量很大程序开发周期长当开发了一段时间后
一些程序代码的含义您也许不会记得很清楚这时您的注释就会有更强的使用意义。
还有一些情况比如前人开发完的程序需要你去维护或扩充功能时
如果有很多清楚的注释就可以去相对容易的去读懂程序的流程以便修改。
更多的代码注释写法您可以参照SUN自己的类注释方法等等。
养成良好的编码习惯是非常重要的。
您也可以参照软件工程的知识进行学习。
JAVA学习很有乐趣记住多实践多学习打好底层知识的功底打开学习面以书本为例不断前进加油吧!
java中的注释可分为三种类型
Java中三种类型的注释:
单行注释://注释内容
多行注释:/*...注释内容....*/
文本注释:/**..注释内容....*/
代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以不是为写注释而写注释。
备注:简单的代码做简单注释,注释内容不大于10个字即可,另外,持久化对象或VO对象的getter、setter方法不需加注释。
扩展资料:
类(模块)注释采用/**……*/,在每个类(模块)的头部要有必要的注释信息,包括:工程名;类(模块)编号;命名空间;类可以运行的JDK版本;版本号;作者;创建时间;类(模块)功能描述(如功能、主要算法、内部各部分之间的关系、该类与其类的关系等,必要时还要有一些如特别的软硬件要求等说明);主要函数或过程清单及本类(模块)历史修改记录等。
参考资料来源:百度百科-java注释
JAVA程序中注释的作用及类型分别是什么
所有程序的注释都是一样的,就是对代码的说明,具体点就是让别人容易理解你代码的意思,也有助于你自己看,如果不加注释可能时间长了,你自己写的代码你自己都不知道什么意思了。
方便自己或他人阅读,提高代码可读性,注释相当于说明书,告诉你代码是干嘛用的,不可能天天自己埋头写代码吧,得借鉴别人的代码,没有注释说明,不能看,或者自己写的代码,没注释说明,你叫人家怎么看。
java 中的几种注释方式
我看动力节点的java基础大全301集教中的三种注释方法:
1、单行注释//注释的内容
2、多行注释/*......*/
3、/**......*/,这种方式和第二种方式相似。这种格式是为了便于javadoc程序自动生成文档。
下面介绍一下Javadoc的标记:
特别声明:
(1)javadoc针对public类生成注释文档
(2)javadoc只能在public、protected修饰的方法或者属性之上
(3)javadoc注释的格式化:前导*号和HTML标签
(4)javadoc注释要仅靠在类、属性、方法之前
下面主要举例说明第三种注释的应用:
(1)首先编写.java文件
(2)在命令行中执行以下dos命令:
javadoc*.java//根据相应的Java源代码及其说明语句生成HTML文档
//javadoc标记:是@开头的,对javadoc而言,特殊的标记。
(3)在当前目录下就会产生doc文件夹,里面有一系列的.html文件
附上代码:
[java]view plaincopy
<spanstyle="font-size:18px;">*/
/**javadoc注释的内容
*/
publicclassHello{
/**属性上的注释*/
publicStringname;
/**这是main方法,是程序的入口
*@paramargs用户输入参数
*/
publicstaticvoidmain(String[]args){
System.out.println("HelloWorld!");
f1();
}
/**这是第1个方法,其作用是...*/
publicstaticvoidf1(){
System.out.println("f1()!");
}
}</span>
[java]view plaincopy
<spanstyle="font-size:18px;">importjava.io.IOException;
/**javadoc注释内容
*@since1.0
*@version1.1
*@authorBlueJey
*<br>链接到另一个文档{@linkHello},就这些
*seeHello
*/
publicclassHelloWorld{
/**非public,protected属性上的注释不生成*/
publicStringname;
/**这是main方法,是程序的入口
*@paramargs用户输入的参数,是数组
*@throwsIOExceptionmain方法io异常
*/
publicstaticvoidmain(Stringargs[])throwsIOException{
System.out.println("helloWorld!");
f1();
f2(1);
}
/**这是第一个方法,其作用是....
*@deprecated从版本1.2开始,不再建议使用此方法
*/
publicstaticvoidf1(){
System.out.println("fl()!");
}
/**这是第二个方法,其作用是....
*@return返回是否OK
*@parami输入参数i
*@seeHello
*@throwsIOExceptionio异常
*/
publicstaticStringf2(inti)throwsIOException{
System.out.println("f1()!");
return"OK";
}
}</span>
注意:
如果源文件中有用到@version,@author标记,则在执行javadoc命令时,要加-version-author
javadoc-version-author-ddoc*.java
(其中用-version用于提取源文件中的版本信息-author用于提取源文件中的作者信息)
关于java中注释起什么作用 有哪几种到此分享完毕,希望能帮助到您。