我有一个小代码示例,我想包含在方法的Javadoc注释中.
/**
* -- ex: looping through List of Map objects --
* <code>
* for (int i = 0; i < list.size(); i++) {
* Map map = (Map)list.get(i);
* System.out.println(map.get("wordID"));
* System.out.println(map.get("word"));
* }
* </code>
*
* @param query - select statement
* @return List of Map objects
*/
Run Code Online (Sandbox Code Playgroud)
问题是代码示例显示在Javadoc中,没有换行符使其难以阅读.
-- ex: looping through List of Map objects -- for (int i = 0; i list.size(); i++) { Map map = (Map)list.get(i); System.out.println(map.get("wordID")); System.out.println(map.get("word")); }
Parameters
query …Run Code Online (Sandbox Code Playgroud) 我正在尝试将集中资源(例如图像文件,js文件)包含到我的Maven生成的javadoc中.这种集中资源将来自依赖.(在我的情况下,我希望始终包含某些资源,Javascript文件,允许在Javadoc中对示例代码进行很好的语法突出显示,以及使用特殊的样式表)
如果您在本地将资源包含在项目中,那么有大量有关如何执行此操作的信息.这不是我想要的,因为我需要为我公司的每个项目做这件事.因此,配置需要进入公司范围的POM文件,我们公司的所有项目都从该文件继承.
请注意,对于样式表,这很容易做到,因为Maven插件允许此文件来自依赖项.我正在寻找类似的东西,除了'资源'.基本上,我不得不将像公司徽标这样的东西复制到每个项目中似乎很愚蠢.这就是我想要避免的.
如果Maven Javadoc插件没有直接支持这个(我不知道是不是这样),那么我猜测另一种方法可能是使用Maven Dependency Plugin将我的集中式javadoc资源复制到项目中.然而,这种方法至少有两个缺点:
这种依赖不是项目的真正依赖,不应该这样说.它是maven-javadoc-plugin的依赖项,而不是项目本身的依赖项.
我需要找到一种方法,以便只在请求javadoc生成时才将依赖项复制到项目中.
请帮忙.