smart-doc 单模块生成文档

最新推荐文章于 2024-07-02 09:52:13 发布

正怒月神

最新推荐文章于 2024-07-02 09:52:13 发布

阅读量572

点赞数

分类专栏：生成文档文章标签： css html

本文链接：https://blog.csdn.net/hanjun0612/article/details/120013161

版权

生成文档专栏收录该内容

6 篇文章

订阅专栏

本文档展示了如何在`build.gradle`中配置Smart Doc插件，以自动化生成项目API文档。配置包括设置服务器URL、输出文件名、路径、严格模式、合并文档、覆盖旧文档以及创建调试页面等选项。同时，还提供了修订日志，记录了项目的更新信息。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

build.gradle

plugins {
    id "com.github.shalousun.smart-doc" version "2.2.2"
}

smartdoc {
    configFile = file("src/main/resources/smart-doc.json")
}

resources/smart-doc.json

{
  "serverUrl": "localhost:9090/web-mac",
  "allInOneDocFileName":"webmac.md",
  "outPath": "webmac",
  "isStrict": false,
  "allInOne": true,
  "coverOld": true,
  "createDebugPage": true,
  "projectName": "pro.webMac",
  "revisionLogs": [{
    "version": "1.0",
    "revisionTime": "2021-08-11 12:00",
    "status": "update",
    "author": "tyler",
    "remarks": "修改命名规范"
  }]
}