javadoc中{@link}与@see的简单使用以及区别
2017-04-29 10:25
375 查看
写代码的时候,有时候,你需要写一些注释,把内容相互关联起来,方便自己或别人看的时候,可以直接找到你关联的代码类或者啥的。
这个时候,{@link}与@see,这2个javadoc注解就派上用场了,
不管他具体有什么功能,咱就只管一个,他可以链接代码,让注释看的更清楚易懂。方便你我他。
@see 标签允许用户引用其他类的文档。具体使用方式如下:
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名称
@see fully-qualified-classname#属性名称
我在使用的时候,发现这个只能单独一行顶头写,如果不顶头写就不管用了,没了链接的效果。
但是,{@link}这个却可以随便放。
具体使用方法和上面那个@see是一样的。
实际效果,看下面的图吧。
这个时候,{@link}与@see,这2个javadoc注解就派上用场了,
不管他具体有什么功能,咱就只管一个,他可以链接代码,让注释看的更清楚易懂。方便你我他。
@see 标签允许用户引用其他类的文档。具体使用方式如下:
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名称
@see fully-qualified-classname#属性名称
我在使用的时候,发现这个只能单独一行顶头写,如果不顶头写就不管用了,没了链接的效果。
但是,{@link}这个却可以随便放。
具体使用方法和上面那个@see是一样的。
实际效果,看下面的图吧。
相关文章推荐
- javadoc中{@link}与@see的简单使用以及区别
- {@link}与@see的简单使用以及区别--如何写好Java代码注释。
- Java中Javadoc的{@link}与@see的简单区别
- hadoop生态系统学习之路(七)impala的简单使用以及与hive的区别
- Yii中关于CHtml::link()的使用说明以及简单细说其CSS样式
- Linux 简单,实用,快速了解静态库和动态库的生成和使用方法以及两者的区别
- javadoc中{@link}与@see的区别
- 简单控件Panel和PlaceHolder的使用区别收藏
- 为何以及如何使用Netlink Socket ( Why and How to Use Netlink Socket)
- 简单控件Panel和PlaceHolder的使用区别
- Lucene的使用以及简单介绍
- XNA Game Studio是一套有着强大功能和简单界面的游戏制作平台,游戏开发商和游戏玩家都可以使用这套工具开发针对Windows XP以及Xbox360的游戏,XNA Game Studio分为两种版本,一种是面向初学者的EXPRESS版本,还有一种是面向专业用户的专业版。用户使用EXPRESS版本开发游戏完全免费,并且可以随意在PC上发行,不过用该工具开发的游戏若是在360上网络发行,就需要交纳99美元的年费。
- javascript入门系列演示·函数的定义以及简单参数使用,调用函数
- 浅析Java执行外部命令的几个要点(1)——简单的使用范例以及在Cygwin上的注意点
- pl的使用以及与Dll的区别
- dtree使用手册以及简单的例子
- 自己对C++虚函数使用的深刻体会,以及覆写,重载的区别?
- javascript入门系列演示·函数的定义以及简单参数使用,调用函数 .txt
- 使用ORACLE和MYSQL的简单区别
- javascript入门系列演示·函数的定义以及简单参数使用,调用函数