【#第一文档网# 导语】以下是®第一文档网的小编为您整理的《java 自动生成代码文档框架 idoc 插件参数配置说明》，欢迎阅读！
i-doc 项目简介 idoc 是为 java 项目生成项目文档。 基于原生的 java 注释，尽可能的生成简介的文档。用户可以自定义自己的模板，生成自己需要的文档。 特性 • • • • 基于 maven 项目生成包含大部分信息的元数据 默认支持 markdown 简化文档的生成，支持自定义模板 支持用户自定义文档生成器 支持用户自定生成文档的类过滤器 参数配置说明 为了更加灵活的实现文档的生成和文档元数据的生成，提供如下参数 插件配置属性简介 是否必说填 明 默认值 否 项UTF-8 目编码 属性 encoding 备注 includes 否 元**\/*.j默认扫描所有 java 文件 数ava 据包含的文件信息 否 元无 默认不排除 excludes isOverwriteWhenExists isAllInOne generates generateFilters 数据排除的文件信息 否 文true 档存在时是否覆盖 否 所true 有类信息是否生成单个文档 否 文命令行档文档生生成信息成类 否 文无 档生成 命令行文档生成器，此属性无意义。 可以同时指定多个。类名全称。用户自定义参见 com.github.houbb.idoc.api.core.genenrator.IDocGenerator 可以同时指定多个。类名全称。用户自定义参见 com.github.houbb.idoc.api.core.filter.IDocGenerateFilter 类过滤器 isAllInOne 简单的文档，建议直接生成在一个文件。 如果较为复杂，则可以设为 false，则会按照 generates 相关问题 默认的命令行文档，主要用于演示和信息查看，不具有实际意义。 建议引入 idoc-ftl 模块，使用 MarkdownDocGenerator 生成器。 可以同时指定多个。 可引入 idoc-api 自行定义。 generateFilters 建议 实际的文档，主要关心定义的方法。 我们可以针对 DocClass 的包名，过滤只生成 Service 方法文档。 如果是在以前的基础上，则可以加上 @since @version 等信息的过滤。 可以同时指定多个。 可引入 idoc-api 自行定义。 本文来源：https://www.dywdw.cn/e37d055ef5ec4afe04a1b0717fd5360cba1a8d9d.html
下载此文档
搜索文档
阅读：
文档下载
2022-05-19
