我研究了很多具有视觉特征的样本测试案例。 是否有任何方便的方法可以将这些案例纳入我的爪哇源中,并将其链接到爪哇中,这样我的IDE就可以在编码时自动显示这些案例(通过在我的IDE中引用 Javadoc 铸造器的特征? ) 。
我尝试将图像放在 Java 源旁边, 并使用 , 但不使用( 我使用 png ) 。
(注 - 在我的测试来源 在本案中)
我研究了很多具有视觉特征的样本测试案例。 是否有任何方便的方法可以将这些案例纳入我的爪哇源中,并将其链接到爪哇中,这样我的IDE就可以在编码时自动显示这些案例(通过在我的IDE中引用 Javadoc 铸造器的特征? ) 。
我尝试将图像放在 Java 源旁边, 并使用 , 但不使用( 我使用 png ) 。
(注 - 在我的测试来源 在本案中)
因为你没有显示任何消息来源, 我只能做一个玻璃球猜想...
对于文档所需的任何文件,您应该将其放在包目录中名为 doc-files
的子目录中。 这些文件会被 Javadoc 简单地复制到输出目录中。 然后在 元素中使用相对路径 。
我不确定你的 IDE s Javadoc 铸造者是否也会这样做, 但值得一试。
有点远, 但是您可以通过将图像转换到 Base64 将图像嵌入到文档中。 它看起来像 :
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA..." />
有在线工具可以进行转换:
与月月的日月,以下为我工作。
现在,在测试.javasjavadoc:
/**
* <img src="./doc-files/image.png" />
*/
日光片以弹出帮助显示图像, 当你在鼠标上徘徊时, 并在 Javadoc 视图中显示图像 。
您甚至可以将 < code> stype= > " width: 100%; " code> 添加到 < code> img code> 标签上, 所以图像会调整到视图/ poup 大小 。
本文是一个具体的例子和进一步的阐述。
Javadocs的文献指出:
要包含未处理的文件, 请将其放入名为 doc 文件的目录中, 它可以是包含源文件的任何软件包目录的子目录 。
如果您将图像文件放在该文件夹中, 图像文件可以通过生成的 HTML 的相对路径提供给 Javadocs HTML 文件 。
因此,如果您的工程命名为 MyMyProject ,而您要添加 Javadoc 评注的类别是 org.foo.ap.ap.app.MyApp ,其源文件夹是 MyProject/src/org/foo/app/MyApp.java ,而您想要将 MyImagage.jpg 包含在它的 s Javadoc中,那么:
创建文件夹 MyProject/src/org/foo/app/doc-files , 并在其中放置图像文件 。
在这一点上,你的Javadocs文本可以这样引用:
<img src="doc-files/MyImage.jpg" width="500" alt="description of MyImage">
Javadocs 生成的 HTML 将反映相应的编码 。
注意“ 宽度” 属性, 允许图像缩放。 高度是按比例缩放的 。
当您运行 Javadocs 时, doc 文件 文件夹将全部复制到 Javadocs 输出文件夹,其中的资源将可供 HTML 使用。
这样试试
/**
* @author KamyninSA
* @version 1
* <p><b>Description</b></p>
* <p><img src="{@docRoot}/../src/test/resources/doc-files/ads.png" alt="alternative directory"></p>
* */
我偶然发现了这个问题,因为我也想展示我的图标的预览。在阅读了答案之后,我还不满意,自己试了一下。 这就是我现在得到的:
/**
* <img src="../../../../../../resources/com/my/project/client/images/myImage.png"><br>
* Icon for myImage.
*
* @return the icon
*/
这样,我不需要管理比以前更多的图像, 只需去到实际图像所在的文件夹。
要扩展Palo的回答, 假设这里的马文建筑是JDK-8(限制 HTML 验证) 对我有效, 规定你愿意运行 Javadoc 工具 。
我刚刚打开了 this netbeans bug 。
假设这是com.foo.File.java的javadoc的一部分(注:没有ig 结尾标签,这是每个w3学校的正确方法):
<img src="doc-files/foo.png" alt="Foo">
在 maven 目录结构中, 您可以在这里找到图像 : src/ main/javadoc/com/ foo/doc-files/ foo. png
最后,在pom.xml(通知docfilessubdirs 被设定为真):
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
<configuration>
<docfilessubdirs>true</docfilessubdirs>
</configuration>
</plugin>
...
Hi have this j2ee web application developed using spring framework. I have a problem with rendering mnessages in nihongo characters from the properties file. I tried converting the file to ascii using ...
Check this, List<String> list = new ArrayList<String>(); for (int i = 0; i < 10000; i++) { String value = (""+UUID.randomUUID().getLeastSignificantBits()).substring(3, ...
I am in the middle of solving a problem where I think it s best suited for a decorator and a state pattern. The high level setting is something like a sandwich maker and dispenser, where I have a set ...
I have been trying to execute a MS SQL Server stored procedure via JDBC today and have been unsuccessful thus far. The stored procedure has 1 input and 1 output parameter. With every combination I ...
I have a system which contains multiple applications connected together using JMS and Spring Integration. Messages get sent along a chain of applications. [App A] -> [App B] -> [App C] We set a ...
If I m given two Java Libraries in Jar format, 1 having no bells and whistles, and the other having lots of them that will mostly go unused.... my question is: How will the larger, mostly unused ...
I have a Class variable that holds a certain type and I need to get a variable that holds the corresponding array class. The best I could come up with is this: Class arrayOfFooClass = java.lang....
I m working on a Java desktop application that reads and writes from/to different files. I think a better solution would be to replace the file system by a SQLite database. How hard is it to migrate ...