java idoc_java 自动生成代码文档框架 idoc 项目模块说明.docx

zz/2024/5/23 1:57:44

i-doc 项目简介

idoc 是为 java 项目生成项目文档。

基于原生的 java 注释,尽可能的生成简介的文档。用户可以自定义自己的模板,生成自己需要的文档。

特性

基于 maven 项目生成包含大部分信息的元数据

默认支持 markdown 简化文档的生成,支持自定义模板

支持用户自定义文档生成器

支持用户自定生成文档的类过滤器

核心思想

数据 + 模板 = 视图

将文档元数据的获取和生成分离。

i-doc 希望达到的目标

对开发者的友好

手写文档的缺点自不用说。

以前也接触过类似 swagger-ui 等基于注解的文档生成工具,但使用起来终究不尽如人意。

基于注解的文档工具,让代码的可读性反而下降。

简洁性

java-doc 生成的文档又过于复杂。

实际使用中希望可以足够简介,比如不同系统之间的文档对接。

灵活性

作为工具,永远不知道使用者需要怎样的信息。

所以分成两大块。

元数据的生成,包含基本所有的文档信息。

文档的生成,提供默认的实现。用户可以基于模板灵活配置,也可以自行实现。

项目模块概览

idoc-api

定义用户使用的 api,提供最基础的接口和元数据。

便于用户在此基础上进行自定义开发,如指定生成文件的过滤方式。

idoc-common

当前项目的基础模块,提供基础的工具方法。

用户也可以引入此模块,进行自己的文档生成实现。

idoc-core

本插件的核心功能,主要负责将 java 文档的元数据信息整理出来,并提供核心的文档生成架构。

idoc-ftl

基于 Freemarker 模板的文档生成,支持其所有语法。

现在主要用于生成 markdown 文档。

用于可以自定义自己的模板,生成更适合自己的 markdown 文档。

idoc-poi

基于 Apache poi 生成 word、pdf 等类型的文档。

0.0.X 版本暂时不引入,后续版本会实现。

idoc-test

测试模块。

一些使用案例可以参考这个模块,同时也为项目的质量提供一定的保证。

项目的格局

语言

后期希望支持 i18n,而不是拘泥于中文项目。

针对性

针对用户的自定义类型,而不是和 java-doc 做重复的事情。


http://www.ngui.cc/zz/1918273.html

相关文章

IDOC重发处理

在使用IDOC的过程中,常会遇到IDOC传输失败报错的情况,第一次遇到这个问题时,有些朋友可能会不知如何处理,今天跟大家分享下一般的处理步骤; 一、查找出错的IDOC号 事务码:WE02 操作:输入创建日期…

java idoc_IDOC练习:发送端配置

第一步WE31创建段(SEGMENT):ZLM_SMT01第二步WE30创建IDOC基本类型 :ZLM_IDOC_TYPE1第三步WE81创建IDOC消息类型 :ZLM_IDOC_MSG1第四步WE82关联基本类型和消息类型第五步SM59创建远程连接 :19TO21第六步WE21创建端口 &…

IDOC原理及实例

转载自:https://blog.csdn.net/hubaichun/article/details/84322312 IDoc(wedi)

ABAP IDOC

IDoc(intermediate(媒介)document)是一种系统间通用的数据交换格式,通过IDoc接口可以实现SAP系统之间以及SAP系统与其他系统之间的数据交换。 IDoc(Intermediate Document,中转文档&#xff09…

ABAP IDOC基本配置

此处案例:300(发送端)、500(接收端) TCODE:WEDI(idoc事务码) 1、定义开发段(300、500都需要配置,除非同一台服务器) TCODE:WE31 如…

idoc java_java - 将iDOC从Java发送到SAP - 堆栈内存溢出

我们有从系统生成的iDOC文件。 现在,我们尝试通过RFC连接将它们发送到SAP。 我已经作为客户端建立了RFC连接,但无法发送iDOC!我试图创建一个样本iDOC进行测试,但是它不起作用!Exception in thread "main" ja…

IDOC报错处理

IDOC数据后台表: EDIDC Stores the Control Record information an IDOC EDID4 Stores the Data Records (version 4.6) EDIDD Data Seg (EDI Intermediate doc) EDIDS Stores the S…

IDOC配置篇 ( 二 )

一、前言 江正军的博客对IDOC介绍非常详细 https://www.cnblogs.com/jiangzhengjun/p/4292135.html#_Toc411677416 二、下面介绍CAR和MDG分别下发小票和物料主数据 三、CAR系统 本文介绍的配置实例是POSDM(CAR)系统产生的IDOC传递到S4 retail的过程的小票IDOC的相关配置 …

IDOC 开发 (三)

一 前言 网上有一个介绍IDOC的文章, 讲的非常详细. 有兴趣的可以看一下. https://www.cnblogs.com/jiangzhengjun/p/4292135.html#_Toc411677416 为了讲解更有条理, 本文介绍的内容是开发一个IDOC用于实现采购订单的修改(数量/价格)及审批 二 开发及配置步骤 按下列步骤…

ABAP传输自定义IDOC实例

首先确定出站方和入站方,本例中我使用150作为发送方将200作为接收方。 发送端系统配置 进入tcode-SALE,点击定义逻辑系统,这里我定义D01CLNT150为发送端,D01CLNT200为接收端 2,将逻辑系统分配给对应的client 3&#x…