<commentGenerator> 元素用来定义注释生成器的属性。 注释生成器用来给由 MyBatis Generator (MBG) 生成的多种元素(Java自动,Java方法,XML元素等等)生成注释。 默认的注释生成器将 JavaDoc 注释添加到所有生成的Java元素上,从而使Eclipse插件可以使用合并Java的功能。 此外,注释还会添加到每一个生成的XML元素。 注释的目的还在于告诉用户这个元素是生成的,并且有可能重新生成(也就是说 - 他们不应该被修改)。 这个元素是 <context> 元素的一个可选的子元素。
默认的实现类是 org.mybatis.generator.internal.DefaultCommentGenerator
。 如果您只想修改某些行为,默认的实现类专门为扩展进行设计。
必选属性
无
可选属性
属性 |
描述 |
type |
使用用户指定提供的注释生成器类型。 这个类必须继承org.mybatis.generator.api.CommentGenerator 接口。 而且必须有一个默认的构造函数。 这个属性接收指定特殊的值 DEFAULT,这将会使用默认的实现类(这和不指定该属性的效果一样)。 |
子元素
支持的属性
这个表格列出了注释生成器中所有可以通过<property>子元素进行设置的属性:
属性名 |
属性值 |
suppressAllComments |
这个属性用来指定MBG生成的代码中是否包含任何注释。 这个属性有以下可选值: |
|
false 这是默认值 当这个属性是false或者没有指定时,所有生成的元素都会包含用来说明这是生成元素的注释。 |
|
true 当这个属性是true时,不会往生成的元素中添加任何注释。 |
|
警告: 如果您将这个值设为true,那么所有的代码合并都会被禁用。 |
suppressDate |
这个元素用来指定生成的注释中是否包含生成的日期。 这个属性有以下可选值: |
|
false 这是默认值 当这个属性是false或者没有指定时,所有元素生成注释时都会带着生成时间。 |
|
true 当这个属性是true时,注释中不会添加时间戳。 |
示例
这个元素指定了我们不希望生成的注释中包含时间戳:
<commentGenerator>
<property name="suppressDate" value="true" />
</commentGenerator>