feat: JavadocConfig setAuthor 和 setSince 方法传入空字符串时，不添加注释 @author, @since 部分

2025-12-06 08:38:26 +08:00 · 2025-02-12 17:02:10 +08:00 · 2025-02-12 17:02:10 +08:00 · 8e0a2b32e2
commit 8e0a2b32e2
parent 71f456bc93
16 changed files with 66 additions and 3 deletions
--- a/docs/zh/others/codegen.md
+++ b/docs/zh/others/codegen.md
@ -213,8 +213,8 @@ globalConfig.enableEntity()

 | 配置                               | 描述              | 默认值                             |
 |----------------------------------|-----------------|---------------------------------|
-| setAuthor(String)                | 作者              | System.getProperty("user.name") |
-| setSince(String)                 | 自               | 日期（yyyy-MM-dd）                  |
+| setAuthor(String)                | 作者（可填写日期、版本号等，设置为 `""` 则不添加 `@author`）  | System.getProperty("user.name") |
+| setSince(String)                 | 自（可填写日期、版本号等，设置为 `""` 则不添加 `@since`） | `yyyy-MM-dd` 格式的日期              |
 | setTableCommentFormat(Function)  | 表注释格式化          | 原表注释                            |
 | setColumnCommentFormat(Function) | 字段注释格式化         | 原字段注释                           |
 | setEntityPackage(String)         | Entity 包注释      | "实体类层（Entity）软件包。"              |
--- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/controller-Solon.tpl
+++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/controller-Solon.tpl
@ -26,8 +26,12 @@ import java.util.List;
 /**
 * #(tableComment) 控制层。
 *
+#if(javadocConfig.getAuthor())
 * @author #(javadocConfig.getAuthor())
+#end
+#if(javadocConfig.getSince())
 * @since #(javadocConfig.getSince())
+#end
 */
@Controller
 #if(withSwagger && swaggerVersion.getName() == "FOX")
--- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/controller.tpl
+++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/controller.tpl
@ -39,8 +39,12 @@ import java.util.List;
 /**
 * #(tableComment) 控制层。
 *
+#if(javadocConfig.getAuthor())
 * @author #(javadocConfig.getAuthor())
+#end
+#if(javadocConfig.getSince())
 * @since #(javadocConfig.getSince())
+#end
 */
 #if(controllerConfig.restStyle)
@RestController
--- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/entity.kotlin.tpl
+++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/entity.kotlin.tpl
@ -18,12 +18,17 @@ import io.swagger.annotations.ApiModelProperty
 #if(withSwagger && swaggerVersion.getName() == "DOC")
 import io.swagger.v3.oas.annotations.media.Schema
 #end
+
 #if(!isBase)
 /**
 * #(table.getComment()) 实体类。
 *
+#if(javadocConfig.getAuthor())
 * @author #(javadocConfig.getAuthor())
+#end
+#if(javadocConfig.getSince())
 * @since #(javadocConfig.getSince())
+#end
 */
 #(table.buildTableAnnotation())
 #end
--- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityOrBase.tpl
+++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityOrBase.tpl
@ -43,8 +43,12 @@ import lombok.EqualsAndHashCode;
 /**
 * #(table.getComment()) 实体类。
 *
+#if(javadocConfig.getAuthor())
 * @author #(javadocConfig.getAuthor())
+#end
+#if(javadocConfig.getSince())
 * @since #(javadocConfig.getSince())
+#end
 */
 #if(withLombok)
 #if(withActiveRecord)
--- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityWithBase.kotlin.tpl
+++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityWithBase.kotlin.tpl
@ -19,11 +19,16 @@ import io.swagger.annotations.ApiModelProperty
 #if(withSwagger && swaggerVersion.getName() == "DOC")
 import io.swagger.v3.oas.annotations.media.Schema
 #end
+
 /**
 * #(table.getComment()) 实体类。
 *
+#if(javadocConfig.getAuthor())
 * @author #(javadocConfig.getAuthor())
+#end
+#if(javadocConfig.getSince())
 * @since #(javadocConfig.getSince())
+#end
 */
 #if(withSwagger && swaggerVersion.getName() == "FOX")
@ApiModel("#(table.getComment())")
--- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityWithBase.tpl
+++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/entityWithBase.tpl
@ -35,12 +35,17 @@ import lombok.NoArgsConstructor;
 #if(jdkVersion >= 14)
 import java.io.Serial;
 #end
+
 #if(!isBase)
 /**
 * #(table.getComment()) 实体类。
 *
+#if(javadocConfig.getAuthor())
 * @author #(javadocConfig.getAuthor())
+#end
+#if(javadocConfig.getSince())
 * @since #(javadocConfig.getSince())
+#end
 */
 #end
 #if(withLombok)
--- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/mapper.kotlin.tpl
+++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/mapper.kotlin.tpl
@ -9,8 +9,12 @@ import #(packageConfig.entityPackage).#(table.buildEntityClassName());
 /**
 * #(table.getComment()) 映射层。
 *
+#if(javadocConfig.getAuthor())
 * @author #(javadocConfig.getAuthor())
+#end
+#if(javadocConfig.getSince())
 * @since #(javadocConfig.getSince())
+#end
 */
 #if(mapperConfig.isMapperAnnotation())
@Mapper
--- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/mapper.tpl
+++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/mapper.tpl
@ -9,8 +9,12 @@ import #(packageConfig.entityPackage).#(table.buildEntityClassName());
 /**
 * #(table.getComment()) 映射层。
 *
+#if(javadocConfig.getAuthor())
 * @author #(javadocConfig.getAuthor())
+#end
+#if(javadocConfig.getSince())
 * @since #(javadocConfig.getSince())
+#end
 */
 #if(mapperConfig.isMapperAnnotation())
@Mapper
--- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/package-info.tpl
+++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/package-info.tpl
@ -1,7 +1,11 @@
 /**
 * #(packageComment)
 *
+#if(javadocConfig.getAuthor())
 * @author #(javadocConfig.getAuthor())
+#end
+#if(javadocConfig.getSince())
 * @since #(javadocConfig.getSince())
+#end
 */
-package #(packageName);
+package #(packageName);
--- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/service.kotlin.tpl
+++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/service.kotlin.tpl
@ -6,7 +6,11 @@ import #(packageConfig.entityPackage).#(table.buildEntityClassName());
 /**
 * #(table.getComment()) 服务层。
 *
+#if(javadocConfig.getAuthor())
 * @author #(javadocConfig.getAuthor())
+#end
+#if(javadocConfig.getSince())
 * @since #(javadocConfig.getSince())
+#end
 */
 interface #(table.buildServiceClassName()) : #(serviceConfig.buildSuperClassName())<#(table.buildEntityClassName())> {}
--- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/service.tpl
+++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/service.tpl
@ -6,8 +6,12 @@ import #(packageConfig.entityPackage).#(table.buildEntityClassName());
 /**
 * #(table.getComment()) 服务层。
 *
+#if(javadocConfig.getAuthor())
 * @author #(javadocConfig.getAuthor())
+#end
+#if(javadocConfig.getSince())
 * @since #(javadocConfig.getSince())
+#end
 */
 public interface #(table.buildServiceClassName()) extends #(serviceConfig.buildSuperClassName())<#(table.buildEntityClassName())> {

--- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl-Solon.tpl
+++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl-Solon.tpl
@ -11,8 +11,12 @@ import org.noear.solon.annotation.Component;
 /**
 * #(table.getComment()) 服务层实现。
 *
+#if(javadocConfig.getAuthor())
 * @author #(javadocConfig.getAuthor())
+#end
+#if(javadocConfig.getSince())
 * @since #(javadocConfig.getSince())
+#end
 */
@Component
 public class #(table.buildServiceImplClassName()) extends ServiceImpl<#(table.buildMapperClassName()), #(table.buildEntityClassName())> #if(table.getGlobalConfig().isServiceGenerateEnable()) implements #(table.buildServiceClassName()) #end{
--- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl.kotlin.tpl
+++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl.kotlin.tpl
@ -11,8 +11,12 @@ import org.springframework.stereotype.Service;
 /**
 * #(table.getComment()) 服务层实现。
 *
+#if(javadocConfig.getAuthor())
 * @author #(javadocConfig.getAuthor())
+#end
+#if(javadocConfig.getSince())
 * @since #(javadocConfig.getSince())
+#end
 */
@Service
 class #(table.buildServiceImplClassName()) : #(serviceImplConfig.buildSuperClassName())<#(table.buildMapperClassName()), #(table.buildEntityClassName())>()#if(table.getGlobalConfig().isServiceGenerateEnable()), #(table.buildServiceClassName())#end {}
--- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl.tpl
+++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/serviceImpl.tpl
@ -25,8 +25,12 @@ import java.util.List;
 /**
 * #(table.getComment()) 服务层实现。
 *
+#if(javadocConfig.getAuthor())
 * @author #(javadocConfig.getAuthor())
+#end
+#if(javadocConfig.getSince())
 * @since #(javadocConfig.getSince())
+#end
 */
@Service
 #if(isCacheExample)
--- a/mybatis-flex-codegen/src/main/resources/templates/enjoy/tableDef.tpl
+++ b/mybatis-flex-codegen/src/main/resources/templates/enjoy/tableDef.tpl
@ -13,8 +13,12 @@ import java.io.Serial;
 /**
 * #(table.getComment()) 表定义层。
 *
+#if(javadocConfig.getAuthor())
 * @author #(javadocConfig.getAuthor())
+#end
+#if(javadocConfig.getSince())
 * @since #(javadocConfig.getSince())
+#end
 */
 public class #(tableDefClassName) extends TableDef {