javadoc中{@link}与@see的区别
来源:互联网 发布:如何找淘宝小二 编辑:程序博客网 时间:2024/05/07 09:51
There are no official guidelines on this, but the facts are:
{@link}
is an inline link and can be placed wherever you like@see
creates its own section
In my opinion, {@link}
is best used when you literally use a class, field, constructor or method name in your description. The user will be able to click through to the javadoc of what you've linked.
I use the @see
annotation in 2 cases:
- Something is very relevant but not mentioned in the description.
- I refer to the same thing multiple times in the description, and it is used as a replacement for multiple links to the same.
I based this opinion on randomly checking out documentation for a great variety of things in the standard library.
转自
0 0
- javadoc中{@link}与@see的区别
- javadoc中{@link}与@see的简单使用以及区别
- {@link}与@see的简单使用以及区别--如何写好Java代码注释。
- CSS中 link与@import的区别
- CSS中link与import的区别
- CSS中link与@import的区别
- Symbolic link 与 Hard link 的区别
- 外部引用CSS中 link与@import的区别
- 外部引用CSS中 link与@import的区别
- 外部引用CSS中 link与@import的区别
- 外部引用CSS中 link与@import的区别
- 外部引用CSS中 link与@import的区别
- 外部引用CSS中 link与@import的区别
- PowerDesigner 中 dependency与 link/ExtendedDependency的区别
- link与@import的区别
- link与@import的区别
- link 与@import的区别
- link与import的区别
- json转xml
- 排序和查找
- [转载]Cocos2d-x 类COC手游与RTS(即时战略)游戏的编程实践总结
- 类的初始化顺序:实例化一个类的对象和访问静态域或者静态方法时的不同
- 一些HTML5的替换写法
- javadoc中{@link}与@see的区别
- Visual Studio2010 出现“此时无足够的可用内存,无法满足操作的预期要求”问题的解决方法
- Codeforces Round #322 D.Three Logos
- php cli命令行模式运行mysql_connect不能连接和运行框架程序
- linux exec函数家族
- monkey测试2-测试策略
- vs2010的opencv2.4.11的配置
- hdu 5492 Find a path DP
- 【HNOI2006】【BZOJ1192】鬼谷子的钱袋