MyBatis-Flex 代码生成器优化：自定义实体类注释配置

在 MyBatis-Flex 项目中，代码生成器(Codegen)是一个重要组件，它能够根据数据库表结构自动生成对应的实体类、Mapper 接口等代码。近期社区对代码生成器中关于实体类注释生成的配置进行了优化，使得开发者可以更灵活地控制生成的注释内容。

注释生成配置的改进

在之前的版本中，MyBatis-Flex 的代码生成器会自动在实体类上生成包含 @since 和 @author 标签的注释。即使用户将这些配置项设置为空字符串，系统仍然会生成带有空标签的注释行，例如：

* @since 
* @author 

这种设计虽然保留了注释结构，但对于不需要这些标签的开发者来说，会产生冗余的代码。最新版本通过社区贡献的代码优化，现在当开发者将 since 或 author 配置设置为空字符串时，系统将完全不再生成对应的注释行，使生成的代码更加简洁。

配置项详解

MyBatis-Flex 的代码生成器提供了 JavadocConfig 类来配置生成的注释内容，主要包括以下配置项：

1. setAuthor(String author) - 设置作者信息
2. setSince(String since) - 设置版本或日期信息
3. setTableComment(String tableComment) - 设置表注释

关于 since 配置项的内容格式，MyBatis-Flex 并没有强制规定必须是日期还是版本号。开发者可以根据项目规范自由选择：

• 可以使用日期格式如 "2025-02-12"
• 可以使用版本号如 "1.0.1"
• 也可以使用其他任意有意义的字符串
• 设置为空字符串则不生成该标签

最佳实践建议

在实际项目开发中，建议团队统一注释规范：

1. 对于公司内部项目，可以统一使用 @author 标注开发者姓名或工号
2. 对于开源项目，@author 可以标注 GitHub 用户名
3. @since 建议使用版本号而非日期，便于追踪功能引入的版本
4. 如果项目不需要这些信息，直接将对应配置设为空字符串即可

总结

MyBatis-Flex 代码生成器的这一优化，体现了框架对开发者友好性的持续改进。通过灵活的注释配置，开发者可以根据项目需求生成最合适的代码结构，既保持了代码的可读性和规范性，又避免了不必要的冗余信息。这一改进将在下一个正式版本中发布，届时开发者可以通过简单的配置就能实现注释内容的完全自定义。