znai： 使用Markdown編寫Java文件系統

banq發表於2022-08-20
AIJava

將文件放在程式碼旁邊非常棒，nai 有豐富的視覺效果和幾十個外掛，可以在構建時嵌入內容。
特點：
  • 帶有自定義擴充套件和數十個外掛的 Markdown：
    • 來自外部檔案的內容，帶有標記和過濾器支援
    • 函式體內容的簡化提取（使用示例）
    • 嵌入 JavaDoc/PyDoc 文件文字，保留樣式
    • 漂亮的 API 文件功能
    • 帶有方便的示例語言切換的兩側頁面佈局選項
    • 豐富的視覺效果，如流程圖和圖表
    • ETC



內容提取
透過使用自定義 Markdown 語法，:include-<pluginname>: params您可以嵌入各種內容。
例如

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

將包含指定方法的內容並省略方法簽名。


描述提取
如果您努力將高階 Java 文件內容新增到您的頂級域概念中，您可以透過使用include-java-doc外掛獲取文字並在更高階別的使用者指南中重複使用

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


在您的Markdown中

:include-java-doc: HelloWorld.java


description extraction example


 

相關文章