如何使用@link
标记链接到方法?
我想改变
/**
* Returns the Baz object owned by the Bar object owned by Foo owned by this.
* A convenience method, equivalent to getFoo().getBar().getBaz()
* @return baz
*/
public Baz fooBarBaz()
Run Code Online (Sandbox Code Playgroud)
至
/**
* Returns the Baz object owned by the Bar object owned by Foo owned by this.
* A convenience method, equivalent to {@link getFoo()}.{@link getBar()}.{@link getBaz()}
* @return baz
*/
public Baz fooBarBaz()
Run Code Online (Sandbox Code Playgroud)
但我不知道如何@link
正确格式化标签.
在@see
处理JavaDocs时我何时使用?它的用途是什么?
例如,如果MethodA
呼叫MethodB
然后做我必须把@see
中MethodB
的javadoc和引用MethodA
,因为这就是所谓呢,还是我已经把一个引用MethodB
从MethodA
,因为它调用它.我已经阅读了@see
Oracle网站上的内容,在我看来它非常模糊,它说它意味着"也看到"但不是真的意味着什么!
我已经开始在评论和文档等中看到类+方法引用,如下所示:
MyClass的#myMethod的
即#
在类和方法之间.这是某种编码标准/惯例吗?