{@link}与@see的简单使用以及区别--如何写好Java代码注释。
2017-03-01 19:58
916 查看
写代码的时候,有时候,你需要写一些注释,把内容相互关联起来,方便自己或别人看的时候,可以直接找到你关联的代码类或者啥的。
这个时候,{@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的简单使用以及区别
- javadoc中{@link}与@see的简单使用以及区别
- 学习如何使用Mybatis-generator 自动生成java代码以及Mapper文件
- Java-流的简单使用:读取文件、写入文件(面试题:删除注释代码)
- 如何写好java代码注释
- 如何使用Github DeskTop客户端以及简单的git指令托管代码到github
- java中equals和==之间的区别?clone方法的作用,及其为什么要使用clone方法?如何使用clone复制对象?以及深克隆浅克隆
- Java中Javadoc的{@link}与@see的简单区别
- Java-流的简单使用:读取文件、写入文件(面试题:删除注释代码)
- 使用EduitPlus来设置java编译和运行命令,以及如何用命令来生成java的API注释文档
- eclipse -- 手把手教你如何把java代码,打包成jar文件以及转换为exe可执行文件
- Java -- POI -- 入门使用以及简单介绍
- Java 8 之 lambda 表达式简单使用入门实例代码。
- 手把手教你如何把java代码,打包成jar文件以及转换为exe可执行文件
- HTML5 websocket 前后端代码(Vue+Java)简单使用
- java.lang.StringBuilder的使用以及如何post方式post xml
- JAVA代码中注释的使用
- [置顶] android,在java代码中,如何给textview设置不同的颜色,以及引用color中资源设置颜色
- MAC 系统如何使用 Sublime Text 2 直接编译运行 java 代码