Javadoc @see 还是 {@link}?
有人能告诉我javadoc和之间的区别吗?@see
{@link}
或者更确切地说,何时使用它们中的哪一个?
有人能告诉我javadoc和之间的区别吗?@see
{@link}
或者更确切地说,何时使用它们中的哪一个?
这方面的官方指导方针非常明确。
功能差异包括:
{@link}
是一个内联链接,可以放置在您喜欢的任何位置@see
创建自己的部分在我看来,当您在描述中实际使用类,字段,构造函数或方法名称时,最好使用它。用户将能够点击到您链接的内容的javadoc。{@link}
我在2种情况下使用注释:@see
我基于随机检查标准库中各种内容的文档来得出此观点。
@see
在 Javadocs 中创建一条隔离的线路。 用于在文本中嵌入。{@link}
当它是一个相关实体时,我会使用它,但我在说明性文本中没有提到它。当存在紧密耦合时,我会在文本中使用链接,或者(我觉得)读者可能会从导航提示中受益,例如,您需要直接引用它。@see