有没有一种方法可以从Javadocs生成Confluence Wiki页面？

Question

有没有一种方法可以从Javadocs生成Confluence Wiki页面？

6

我希望在Confluence Wiki上为我的项目编写文档，并且我想从javadocs自动生成一些文档。是否有适用于Confluence的插件可以轻松实现这一点（初步搜索未见），或者是否有人编写了基于javadocs将wiki页面发布到Confluence的脚本？如果有ant任务，那就太酷了，然后我可以将wiki作为目标。

- skay

3个回答

2

Confluence JavaDocs Macros是一款插件，可以从javadocs生成wiki页面。缺点是必须制作一个zip归档文件，并将其放置在空间的第一页，而且同一空间中不能存在多个javadocs。

该插件也不兼容Confluence的每个版本。

如果您只有一个Confluence服务器（或Confluence服务器是主要文档托管位置），并且想要添加javadocs到Confluence，那么您可能需要这个插件...这种情况以前也发生过。

- ggissel

1

你可以使用文档插件：https://marketplace.atlassian.com/plugins/net.meixxi.confluence.docs.docs-plugin。该插件使您能够在Confluence中上传和发布JavaDocs和其他基于HTML和JavaScript的内容。

Docs还提供了一个REST接口，以便自动化发布过程。因此，发布JavaDocs可以成为持续集成流程的一部分。您可以在这里找到技术文档以及示例代码：https://ricebean.net/confluence-docs

- meixxi

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Verhagen · Accepted Answer

为什么要将javadoc上传到编辑系统中？这听起来相当奇怪。我们创建了一个Apache服务器，将项目文档（由Java生成的javadoc和一些项目文档（我们也存储在项目（SCM内））上传到其中。

除此之外，我们还有一个Wiki系统，任何人都可以在其中编写各种内容。在大多数Wiki中，很容易进行外部引用（指向Apache Web服务器、项目文档/javadoc页面）。

好处是，项目文档可以通过ant/maven等重新生成并自动上传到某个Web服务器。只能读取而不能修改。这只能通过项目源代码完成。这很好，因为否则人们会开始编辑Wiki页面，然后这些页面会不时被替换，因为新的构建/发布已经创建了。