znai： 使用Markdown编写Java文档系统

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

特点：

• 带有自定义扩展和数十个插件的 Markdown：

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

内容提取

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

例如

:include-java: MyClass.java {entry: "myMethod", bodyOnly: true}

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

描述提取

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

/**
 * Top level conceptual description of a {@link CustomDomain} problem.
 * 

 * To avoid copy & paste of the content consider to re-use information.
 */
class HelloWorld {

在您的Markdown中

:include-java-doc: HelloWorld.java