从javadoc评论中链接到@see标记

我正在为一个类编写javadoc，并且特定段落必须由外部链接支持。我的想法是把这个链接放在类的'javadoc末尾的@see标签中，同时将段落链接到@see标签，但我不知道该怎么做。也许我的方法是错误的，我应该在相关的特定段落中包含链接，而不是将其与@see标签的其余部分合并。从javadoc评论中链接到@see标记

来源

2012-03-21 DPM

@see标记是引用其他类。如果你想要一个简单的HTML链接到互联网的使用在你的文档文本中的HTML链接：

/** 
* here comes a link <a href="http://google.com">http://google.com</a> 
*/

你也可以用@see标签盈HTML链接的做到这一点，以获得链接的底部列出你的班。

来源

2012-07-17 12:31:40 Simulant

我认为这不仅适用于课堂。你可以在这里看到它：http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#@see它谈论一个“参考”。无论如何，我想我只是在参考部分和文档的适当部分重复了链接。 – DPM 2012-07-18 21:12:39

没错。我想提到'@ see'只会在类或方法上创建自动生成的链接，而不会在Web链接上创建。因此你需要添加' – Simulant 2012-07-19 17:58:49

从javadoc评论中链接到@see标记

回答

相关问题