
文档注释可以用eclipse导出chm格式的帮助文档,拿给其他人用时,方便他人理解。文档注释被调用的方法,当鼠标移到上面时提醒注释内容。
使用文档注释时,需要在开始的 /** 之后,第一行或几行是关于类、变量和方法的主要描述。
之后,可以包含一个或多个何种各样的@ 标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该消陵放成一组。
2、【多行注释】注释的也是方法或类,言下之意就是一次性的将程序中的多行代码注释掉,但多行注释的内容不能用于生成一个开发者文档。
3、【多行注释与文档注释的区别】多行注释的内容不能用于生成一个开发者文档,而文档注释 的内容可以生产一个开发者文档。
扩展资料
java常用的文档注释标签
1、@author:标识一个类的作者
实例: @author description
2、@deprecated:指名一个过期的类或成员
实例: @deprecated description
3、@exception:标志一个类抛出的异常
实例:@exception exception-name explanation
4、{@inheritDoc}:从直接父类继承的注释颂禅
实例:Inherits a comment from the immediate surperclass.
5、{@link}:插入一个到另一个主题的链接
实例:{@link name text}
6、{@linkplain}:插拿樱戚入一个到另一个主题的链接,但是该链接显示纯文本字体
实例:Inserts an in-line link to another topic.
7、@param:说明一个方法的参数
实例:@param parameter-name explanation
8、@return:说明返回值类型
实例:@return explanation
9、@see:指定一个到另一个主题的链接
实例:@see anchor
10、@serial:说明一个序列化属性
实例:@serial description
参考资料:百度百科-java注释
mysql 服务器支持 # 到该行结束、-- 到该行结束 以及 /* 行中间或多个行伏陵 */ 的注释方格:
mysql>SELECT 1+1 # 这个注释直到该行结束
mysql>SELECT 1+1 -- 这个注释直到该行结束
mysql>SELECT 1 /* 这是一个在行中间的注释 */ + 1
mysql>SELECT 1+
/*
这是一个
多行注释的形式
*/
1
注意 -- (双长划) 注释风格要求在两个长划后至少有一个空格!
尽管服务器理解刚才描述的注释句法,但 MySQL 客户端的语法分析在 /* ... */ 注释方式上还有所限止:
单引号和双引号被用来标志一个被引用字符串的开始,即使是在一缺改戚个注释中。如果注释中的引号没有另一个引号与之配对,那和语法分析程序就不会认为注释结束。如果你以交互式运行 mysql,你会产生困惑,因为提示符从 mysql>变为 '>或 ">。
一个分号被用于指出当前 SQL 语句的结束并且跟随它的任何东西表示下一行的开始。
不论你是以交互式运行 mysql 还是将命令放在一个文件中,歼斗然后以 mysql <some-file 告诉 mysql 读取它的输入,这个限制均存在。
欢迎分享,转载请注明来源:内存溢出
微信扫一扫
支付宝扫一扫
评论列表(0条)