《java 自动生成代码文档框架 i 插件参数配置说明》由会员分享，可在线阅读，更多相关《java 自动生成代码文档框架 i 插件参数配置说明（3页珍藏版）》请在金锄头文库上搜索。
1、i-doc 项目简介idoc是为java项目生成项目文档。基于原生的java注释，尽可能的生成简介的文档。用户可以自定义自己的模板, 生成自己需要的文档。特性 基于maven项目生成包含大部分信息的元数据 默认支持markdown简化文档的生成，支持自定义模板 支持用户自定义文档生成器 支持用户自定生成文档的类过滤器参数配置说明为了更加灵活的实现文档的生成和文档元数据的生成，提供如下参数插件配置属性简介是否 必说属性填 明 默认值 备注encoding否 项 UTF-8includesexcludes目 编 码 元 数据 包 含 的 文 件 信 息 元 否否*/*.j默认扫描所有java文件a
2、va无默认不排除isOverwriteWhenExistsisAllInOnegeneratesgenerateFilters否否数 据 排 除 的 文 件 信 息 文 档 存 在 时 是 否 覆 盖 所 有 类 信 息 是 否 生 成 单 个 文 档 文 档 生 成 类 文 档 生 成行生息令档信命文成命令行文档生成器，此属性无意义。可以同时指定多个。类名全称。用户自定义参 见 com.github.houbb.idoc.api.core.genenrat or.IDocGenerator可以同时指定多个。类名全称。用户自定义参 见 com.github.houbb.idoc.api.cor
3、e.filter.I DocGenerateFilter类过滤器isAllInOne简单的文档，建议直接生成在一个文件。如果较为复杂，则可以设为false，则会按照generates 相关问题 默认的命令行文档，主要用于演示和信息查看，不具有实际意义。 建议引入 idocftl 模块，使用 MarkdownDocGenerator 生成器。 可以同时指定多个。可引入 idocapi 自行定义。 generateFilters 建议 实际的文档，主要关心定义的方法。我们可以针对DocClass的包名，过滤只生成Service方法文档。 如果是在以前的基础上，则可以加上 since version 等信息的过滤 可以同时指定多个。可引入 idocapi 自行定义。
