我有两个包,Shapes
和Fruits
:
com.myproject.Shapes.
Circle
Square
Triangle
com.myproject.Fruits.
Apple
Orange
我正在为JavaDoc编写代码,Apple
并且需要提供{@link}
to Square
。
我已经尝试了以下所有方法,但都不起作用:
{@link Square}
{@link com.myproject.Square}
我已经找到链接到以下文档的文档:(a)同一包中的类,或(b)外部URL,但另一个包中的类。
任何想法正确的语法应该是什么?谢谢!
在正确的语法变种
{@link [<package>.]<class>[#<method>]}
{@link #<method>}
您缺少完整的软件包。下面的例子应该是正确的
{@link com.myproject.Shapes.Square}
^^^^^^
问题内容: 就像是: 问题答案: 这将创建一个包含链接的“另请参阅”标题,即: 将呈现为: 另请参见: http : //google.com 而这: 将创建一个嵌入式链接: 见http://google.com
我正在为未来的公共API编写一个招摇过市的规范,它需要非常详细和干净的文档。是否有方法在swagger中的其他位置引用/链接/指向另一个endpoint。yml文件? 例如,这是我正在努力实现的目标: 我发现没有帮助,因为它只是用引用的内容替换自己。 斯威格能做这种事吗?
问题内容: 我知道有,但仅适用于覆盖其他方法的方法。 我有几个带有许多 委托 方法的类(它们 不会 覆盖其他方法)。 他们的Javadoc是否可以“继承”(更确切地说是复制)? 问题答案: @link或@see标记在这里比较合适。如果要包装该方法,则它必须提供独特的行为,这使其不适用于重载或其他情况。
问题内容: 目前,我正在使用此Javadoc语法引用其他类中的方法: 根据我从文档中了解到的,这是执行此操作的正确方法。但是现在到了有趣的部分,还是令人沮丧。当我生成此javadoc时,首先出现以下错误: 生成的HTML代码是: 当然,我没有任何联系。谁能告诉我发生了什么,以及有关如何解决此问题的任何提示? 根据ASCII表,用于wold的字符123和64分别表示{和@,因此,根据文档,当此语法正
问题内容: 我正在生成Javadocs。现在,我想自动将所有库和JDK类链接到该lib或JDK的官方文档。这可能吗,如果可以,我需要哪个命令行参数 问题答案: 解决对标准Java类的引用需要您具有Java Docs的本地副本。 JDK 7 JavaDocs可在此处的其他资源下找到。 然后,运行带有选项的javadoc 。它使用您要参考的文档的URL(例如,https://docs.oracle.c
我想知道如何链接到同一liferay网站中的另一个页面。 显然,我可以在我的portlet视图中硬编码url,但是我担心必须更新所有的portlet,以防友好的url在未来发生变化。 我知道我试图链接到的页面的名称,但是如果页面名称也改变了呢? 我发现了无数具有返回友好URL的方法的类,例如,,甚至,但它们都需要我不确定如何获取的参数。 是否有一个标准的方式获得友好的网址?