Skip to content

Commit 7c5ffdd

Browse files
committed
docs(pom): annotate all 3.0.x poms in ddd4j style
Follow the ddd4j-dependencies/pom.xml comment conventions: grouped properties (core/third-party/plugin versions), per-dependency mvnrepository Source links + purpose/override rationale in dependencyManagement, grouped dependencies (For X / Test) with per-entry usage, plugin links + usage, and profile explanations. Comments only — no version/dependency/structure changes. All 13 poms parse (mvn validate) and core compiles.
1 parent 4a51d03 commit 7c5ffdd

13 files changed

Lines changed: 264 additions & 147 deletions

File tree

easydoc-beetl/pom.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,14 @@
1313
<packaging>jar</packaging>
1414

1515
<dependencies>
16+
<!-- easydoc-xhtml 模块(XHTML 模板处理核心) -->
1617
<dependency>
1718
<groupId>${project.groupId}</groupId>
1819
<artifactId>easydoc-xhtml</artifactId>
1920
<version>${project.version}</version>
2021
</dependency>
2122
<!-- https://mvnrepository.com/artifact/com.ibeetl/beetl -->
23+
<!-- Beetl 模板引擎(高性能 Java 模板引擎) -->
2224
<dependency>
2325
<groupId>com.ibeetl</groupId>
2426
<artifactId>beetl</artifactId>

easydoc-bom/pom.xml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,56 +13,67 @@
1313

1414
<dependencyManagement>
1515
<dependencies>
16+
<!-- easydoc 核心模块(docx4j 封装、XHTML 模型、通用工具类) -->
1617
<dependency>
1718
<groupId>${project.groupId}</groupId>
1819
<artifactId>easydoc-core</artifactId>
1920
<version>${project.version}</version>
2021
</dependency>
22+
<!-- Beetl 模板引擎适配模块 -->
2123
<dependency>
2224
<groupId>${project.groupId}</groupId>
2325
<artifactId>easydoc-beetl</artifactId>
2426
<version>${project.version}</version>
2527
</dependency>
28+
<!-- FreeMarker 模板引擎适配模块 -->
2629
<dependency>
2730
<groupId>${project.groupId}</groupId>
2831
<artifactId>easydoc-freemarker</artifactId>
2932
<version>${project.version}</version>
3033
</dependency>
34+
<!-- HTTL 模板引擎适配模块 -->
3135
<dependency>
3236
<groupId>${project.groupId}</groupId>
3337
<artifactId>easydoc-httl</artifactId>
3438
<version>${project.version}</version>
3539
</dependency>
40+
<!-- Jetbrick Template 模板引擎适配模块 -->
3641
<dependency>
3742
<groupId>${project.groupId}</groupId>
3843
<artifactId>easydoc-jetbrick</artifactId>
3944
<version>${project.version}</version>
4045
</dependency>
46+
<!-- JSP 模板引擎适配模块(基于 Tomcat Jasper) -->
4147
<dependency>
4248
<groupId>${project.groupId}</groupId>
4349
<artifactId>easydoc-jsp</artifactId>
4450
<version>${project.version}</version>
4551
</dependency>
52+
<!-- Rythm 模板引擎适配模块 -->
4653
<dependency>
4754
<groupId>${project.groupId}</groupId>
4855
<artifactId>easydoc-rythm</artifactId>
4956
<version>${project.version}</version>
5057
</dependency>
58+
<!-- Thymeleaf 模板引擎适配模块 -->
5159
<dependency>
5260
<groupId>${project.groupId}</groupId>
5361
<artifactId>easydoc-thymeleaf</artifactId>
5462
<version>${project.version}</version>
5563
</dependency>
64+
<!-- Velocity 模板引擎适配模块 -->
5665
<dependency>
5766
<groupId>${project.groupId}</groupId>
5867
<artifactId>easydoc-velocity</artifactId>
5968
<version>${project.version}</version>
6069
</dependency>
70+
<!-- Webit Script 模板引擎适配模块 -->
6171
<dependency>
6272
<groupId>${project.groupId}</groupId>
6373
<artifactId>easydoc-webit</artifactId>
6474
<version>${project.version}</version>
6575
</dependency>
76+
<!-- XHTML 模板处理模块(Jsoup + docx4j ImportXHTML) -->
6677
<dependency>
6778
<groupId>${project.groupId}</groupId>
6879
<artifactId>easydoc-xhtml</artifactId>

easydoc-core/pom.xml

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,33 @@
1414
<packaging>jar</packaging>
1515

1616
<dependencies>
17-
18-
17+
18+
<!-- ======== Apache Commons ======== -->
19+
<!-- Commons Lang3(字符串、Object、枚举等通用工具类) -->
1920
<dependency>
2021
<groupId>org.apache.commons</groupId>
2122
<artifactId>commons-lang3</artifactId>
2223
</dependency>
24+
<!-- Commons IO(IO 流工具类,文件复制/过滤等) -->
2325
<dependency>
2426
<groupId>commons-io</groupId>
2527
<artifactId>commons-io</artifactId>
2628
</dependency>
27-
28-
<!-- ###################### Docx4j ###################### -->
29-
30-
<!-- Docx4j Core -->
29+
30+
<!-- ======== Docx4j ======== -->
31+
32+
<!-- Docx4j Core(Word/Excel/PPT 的 OOXML 读写引擎) -->
3133
<dependency>
3234
<groupId>org.docx4j</groupId>
3335
<artifactId>docx4j-core</artifactId>
3436
</dependency>
35-
37+
3638
<!-- Docx4j JAXB Internal
3739
<dependency>
3840
<groupId>org.docx4j</groupId>
3941
<artifactId>docx4j-JAXB-Internal</artifactId>
4042
</dependency> -->
41-
43+
4244
<!-- Docx4j JAXB ReferenceImpl (replaces MOXy).
4345
4446
docx4j-JAXB-MOXy 11.5.14 cannot be used on JDK 21 + jakarta.xml.bind-api 4.x:
@@ -69,11 +71,13 @@
6971
护栏;如下游按 11.5.14 mvnrepository 片段复制粘贴,此处会构建失败提示 -->
7072

7173
<!-- https://mvnrepository.com/artifact/ognl/ognl -->
74+
<!-- OGNL(对象图导航语言,docx4j 模板变量表达式求值) -->
7275
<dependency>
7376
<groupId>ognl</groupId>
7477
<artifactId>ognl</artifactId>
7578
</dependency>
7679

80+
<!-- ======== Test ======== -->
7781
<!-- SLF4J binding(test scope):否则测试类路径上没有任何 provider,
7882
LOG.warn 会落到 NOP logger,WordprocessingMLTemplateVariantsTest
7983
无法断言 JDK 21 透明降级的 WARN 日志(slf4j-simple 默认输出到
@@ -84,7 +88,6 @@
8488
<scope>test</scope>
8589
</dependency>
8690

87-
8891
<!-- JAXB 4.x runtime provider. docx4j 11.5.14 statically initializes
8992
org.docx4j.jaxb.Context to look up jakarta.xml.bind.JAXBContext
9093
via ServiceLoader; the default fallback class

easydoc-freemarker/pom.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,14 @@
1414

1515

1616
<dependencies>
17+
<!-- easydoc-xhtml 模块(XHTML 模板处理核心) -->
1718
<dependency>
1819
<groupId>${project.groupId}</groupId>
1920
<artifactId>easydoc-xhtml</artifactId>
2021
<version>${project.version}</version>
2122
</dependency>
2223
<!-- https://mvnrepository.com/artifact/org.freemarker/freemarker -->
24+
<!-- FreeMarker 模板引擎(通用模板引擎,支持 FTL 语法) -->
2325
<dependency>
2426
<groupId>org.freemarker</groupId>
2527
<artifactId>freemarker</artifactId>

easydoc-httl/pom.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,14 @@
1313
<packaging>jar</packaging>
1414

1515
<dependencies>
16+
<!-- easydoc-xhtml 模块(XHTML 模板处理核心) -->
1617
<dependency>
1718
<groupId>${project.groupId}</groupId>
1819
<artifactId>easydoc-xhtml</artifactId>
1920
<version>${project.version}</version>
2021
</dependency>
2122
<!-- https://mvnrepository.com/artifact/org.perfcake/httl -->
23+
<!-- HTTL 模板引擎(高性能模板引擎,类似 Velocity 语法) -->
2224
<dependency>
2325
<groupId>org.perfcake</groupId>
2426
<artifactId>httl</artifactId>

easydoc-jetbrick/pom.xml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,15 @@
1313
<packaging>jar</packaging>
1414

1515
<dependencies>
16+
<!-- easydoc-xhtml 模块(XHTML 模板处理核心) -->
1617
<dependency>
1718
<groupId>${project.groupId}</groupId>
1819
<artifactId>easydoc-xhtml</artifactId>
1920
<version>${project.version}</version>
2021
</dependency>
2122
<!-- https://mvnrepository.com/artifact/com.github.subchen/jetbrick-template -->
23+
<!-- Jetbrick Template 模板引擎(类 JSP 语法的高性能模板引擎);
24+
排除传递的 antlr4-runtime,使用模块内显式声明的 4.7.1 版本 -->
2225
<dependency>
2326
<groupId>com.github.subchen</groupId>
2427
<artifactId>jetbrick-template</artifactId>
@@ -31,6 +34,7 @@
3134
</exclusion>
3235
</exclusions>
3336
</dependency>
37+
<!-- ANTLR4 运行时 4.7.1(与 jetbrick-template 2.1.10 编译版本匹配) -->
3438
<dependency>
3539
<groupId>org.antlr</groupId>
3640
<artifactId>antlr4-runtime</artifactId>

easydoc-jsp/pom.xml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,22 @@
1313
<packaging>jar</packaging>
1414

1515
<dependencies>
16+
<!-- easydoc-xhtml 模块(XHTML 模板处理核心) -->
1617
<dependency>
1718
<groupId>${project.groupId}</groupId>
1819
<artifactId>easydoc-xhtml</artifactId>
1920
<version>${project.version}</version>
2021
</dependency>
22+
<!-- Jakarta Servlet API 6.0(Tomcat 10.1 的 servlet 接口,provided scope 由容器提供) -->
2123
<dependency>
2224
<groupId>jakarta.servlet</groupId>
2325
<artifactId>jakarta.servlet-api</artifactId>
2426
<version>${jakarta.servlet-api.version}</version>
2527
</dependency>
2628
<!-- Tomcat 10.1.x Jasper JSP engine (replaces the hand-rolled easydoc-jsp engine).
2729
Tomcat 10.1 uses the Jakarta EE 10 (jakarta.servlet) namespace. -->
30+
<!-- https://mvnrepository.com/artifact/org.apache.tomcat/tomcat-jasper -->
31+
<!-- Tomcat Jasper(JSP 编译与运行引擎,将 JSP 模板编译为 Servlet) -->
2832
<dependency>
2933
<groupId>org.apache.tomcat</groupId>
3034
<artifactId>tomcat-jasper</artifactId>

easydoc-rythm/pom.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,14 @@
1313
<packaging>jar</packaging>
1414

1515
<dependencies>
16+
<!-- easydoc-xhtml 模块(XHTML 模板处理核心) -->
1617
<dependency>
1718
<groupId>${project.groupId}</groupId>
1819
<artifactId>easydoc-xhtml</artifactId>
1920
<version>${project.version}</version>
2021
</dependency>
2122
<!-- https://mvnrepository.com/artifact/org.rythmengine/rythm-engine -->
23+
<!-- Rythm 模板引擎(类 Razor 语法的高性能 Java 模板引擎) -->
2224
<dependency>
2325
<groupId>org.rythmengine</groupId>
2426
<artifactId>rythm-engine</artifactId>

easydoc-thymeleaf/pom.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,14 @@
1313
<packaging>jar</packaging>
1414

1515
<dependencies>
16+
<!-- easydoc-xhtml 模块(XHTML 模板处理核心) -->
1617
<dependency>
1718
<groupId>${project.groupId}</groupId>
1819
<artifactId>easydoc-xhtml</artifactId>
1920
<version>${project.version}</version>
2021
</dependency>
2122
<!-- https://mvnrepository.com/artifact/org.thymeleaf/thymeleaf -->
23+
<!-- Thymeleaf 模板引擎(自然模板引擎,支持 HTML 原型直接预览) -->
2224
<dependency>
2325
<groupId>org.thymeleaf</groupId>
2426
<artifactId>thymeleaf</artifactId>

easydoc-velocity/pom.xml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,27 @@
1414
<packaging>jar</packaging>
1515

1616
<dependencies>
17+
<!-- easydoc-xhtml 模块(XHTML 模板处理核心) -->
1718
<dependency>
1819
<groupId>${project.groupId}</groupId>
1920
<artifactId>easydoc-xhtml</artifactId>
2021
<version>${project.version}</version>
2122
</dependency>
23+
<!-- ======== Velocity 模板引擎 ======== -->
24+
<!-- https://mvnrepository.com/artifact/org.apache.velocity/velocity-engine-core -->
25+
<!-- Velocity 引擎核心(VTL 模板解析与渲染) -->
2226
<dependency>
2327
<groupId>org.apache.velocity</groupId>
2428
<artifactId>velocity-engine-core</artifactId>
2529
</dependency>
30+
<!-- https://mvnrepository.com/artifact/org.apache.velocity/velocity-engine-scripting -->
31+
<!-- Velocity Scripting(JSR 223 脚本引擎支持) -->
2632
<dependency>
2733
<groupId>org.apache.velocity</groupId>
2834
<artifactId>velocity-engine-scripting</artifactId>
2935
</dependency>
36+
<!-- https://mvnrepository.com/artifact/org.apache.velocity/velocity-tools -->
37+
<!-- Velocity Tools(Web 工具集,排除过时的 Struts 依赖) -->
3038
<dependency>
3139
<groupId>org.apache.velocity</groupId>
3240
<artifactId>velocity-tools</artifactId>

0 commit comments

Comments
 (0)