如何在java程序中添加注释
1、单行(single-line)--短注释://…… 单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。 注释格式:/* 注释内容 */ 行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。 注释格式:// 注释内容 行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释必须对齐。 注释格式:代码 + 8(至少4)个空格 + // 注释内容
成都创新互联公司公司2013年成立,先为陵水黎族等服务建站,陵水黎族等地企业,进行企业商务咨询服务。为陵水黎族企业网站制作PC+手机+微官网三网同步一站式服务解决您的所有建站问题。
2、块(block)--块注释:/*……*/ 注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成: /* * 注释内容 */
3、文档注释:/**……*/ 注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符 /**......*/ ...
java中的注释可分为三种类型
Java中三种类型的注释:
单行注释:// 注释内容
多行注释:/*... 注释内容....*/
文本注释:/**.. 注释内容....*/
代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以不是为写注释而写注释。
备注:简单的代码做简单注释,注释内容不大于10个字即可,另外,持久化对象或VO对象的getter、setter方法不需加注释。
扩展资料:
类(模块)注释采用 /** …… */,在每个类(模块)的头部要有必要的注释信息,包括:工程名;类(模块)编号;命名空间;类可以运行的JDK版本;版本号;作者;创建时间;类(模块)功能描述(如功能、主要算法、内部各部分之间的关系、该类与其类的关系等,必要时还要有一些如特别的软硬件要求等说明);主要函数或过程清单及本类(模块)历史修改记录等。
参考资料来源:百度百科-java注释
java 文档注释是注释什么的,不是有多行注释了吗?
1、【文档注释】是写在类或者方法的上面的。
文档注释可以用eclipse导出chm格式的帮助文档,拿给其他人用时,方便他人理解。文档注释被调用的方法,当鼠标移到上面时提醒注释内容。
使用文档注释时,需要在开始的 /** 之后,第一行或几行是关于类、变量和方法的主要描述。
之后,可以包含一个或多个何种各样的@ 标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该放成一组。
2、【多行注释】注释的也是方法或类,言下之意就是一次性的将程序中的多行代码注释掉,但多行注释的内容不能用于生成一个开发者文档。
3、【多行注释与文档注释的区别】多行注释的内容不能用于生成一个开发者文档,而文档注释的内容可以生产一个开发者文档。
扩展资料
java常用的文档注释标签
1、@author:标识一个类的作者
实例: @authordescription
2、@deprecated:指名一个过期的类或成员
实例: @deprecateddescription
3、@exception:标志一个类抛出的异常
实例:@exceptionexception-nameexplanation
4、{@inheritDoc}:从直接父类继承的注释
实例:Inheritsacommentfromtheimmediatesurperclass.
5、{@link}:插入一个到另一个主题的链接
实例:{@linknametext}
6、{@linkplain}:插入一个到另一个主题的链接,但是该链接显示纯文本字体
实例:Insertsanin-linelinktoanothertopic.
7、@param:说明一个方法的参数
实例:@paramparameter-nameexplanation
8、@return:说明返回值类型
实例:@returnexplanation
9、@see:指定一个到另一个主题的链接
实例:@seeanchor
10、@serial:说明一个序列化属性
实例:@serialdescription
参考资料:百度百科-java注释
为什么要为程序添加注释,在java程序中如何为程序添加注释?
注释是用来给开发者或者是软件后续的维护者来看的。一般是用来描述这一段代码或者是程序做了些什么样的事情。实现了哪些功能,java里面注释代码,可以分为行注释和块注释,方法注释等。
行注释就是在需要注释的代码前加 //
块注释则是用 /* 和 */ 把文本段落框起来即可
本文标题:java代码行注解 java代码注释符号
标题网址:http://scgulin.cn/article/ddsgjsi.html