Java绝对精品!如何快速搭建自己的文档系统(warkdown)

主题 Java Markdown

将文档放在代码旁边非常棒，nai 有丰富的视觉效果和几十个插件，可以在构建时嵌入内容。

特点：

• 带有自定义扩展和数十个插件的 Markdown：
• 来自外部文件的内容，带有标记和过滤器支持
• 函数体内容的简化提取（使用示例）
• 嵌入 JavaDoc/PyDoc 文档文本，保留样式
• 漂亮的 API 文档功能
• 带有方便的示例语言切换的两侧页面布局选项
• 丰富的视觉效果，如流程图和图表
• ETC

内容提取

通过使用自定义 Markdown 语法，:include-<pluginname>: params您可以嵌入各种内容。

例如

:include-java: MyClass.java {entry: <font>"myMethod"</font><font>, bodyOnly: <b>true</b>}
</font>

将包含指定方法的内容并省略方法签名。

描述提取

如果您努力将高级 Java 文档内容添加到您的顶级域概念中，您可以通过使用include-java-doc插件获取文本并在更高级别的用户指南中重复使用

<font><i>/**
 * Top level conceptual description of a {@link CustomDomain} problem.
 * <p>
 * To avoid <b>copy & paste</b> of the content consider to re-use information.
 */</i></font><font>
<b>class</b> HelloWorld {
</font>

在您的Markdown中

:include-java-doc: HelloWorld.java

description extraction example