&lt;commentGenerator&gt; 元素 · Java 開源項目中文文檔

# <commentGenerator> 元素 <commentGenerator> 元素用來定義注釋生成器的屬性。注釋生成器用來給由 MyBatis Generator (MBG) 生成的多種元素（Java自動，Java方法，XML元素等等）生成注釋。默認的注釋生成器將 JavaDoc 注釋添加到所有生成的Java元素上，從而使Eclipse插件可以使用合并Java的功能。此外，注釋還會添加到每一個生成的XML元素。注釋的目的還在于告訴用戶這個元素是生成的，并且有可能重新生成（也就是說 - 他們不應該被修改）。這個元素是 [<context>](context.html) 元素的一個可選的子元素。默認的實現類是 `org.mybatis.generator.internal.DefaultCommentGenerator`。如果您只想修改某些行為，默認的實現類專門為擴展進行設計。 ## 必選屬性無 ## 可選屬性 | 屬性 | 描述 | | --- | --- | | type | 使用用戶指定提供的注釋生成器類型。這個類必須繼承`org.mybatis.generator.api.CommentGenerator`接口。而且必須有一個默認的構造函數。這個屬性接收指定特殊的值 DEFAULT，這將會使用默認的實現類（這和不指定該屬性的效果一樣）。 | ## 子元素 * [<property>](property.html) (0..N) ## 支持的屬性這個表格列出了注釋生成器中所有可以通過[<property>](property.html)子元素進行設置的屬性： | 屬性名 | 屬性值 | | --- | --- | | suppressAllComments | 這個屬性用來指定MBG生成的代碼中是否包含任何注釋。這個屬性有以下可選值： | | | false _這是默認值_ 當這個屬性是false或者沒有指定時，所有生成的元素都會包含用來說明這是生成元素的注釋。 | | | true 當這個屬性是true時，不會往生成的元素中添加任何注釋。 | | | **警告:** 如果您將這個值設為true，那么所有的代碼合并都會被禁用。 | | suppressDate | 這個元素用來指定生成的注釋中是否包含生成的日期。這個屬性有以下可選值： | | | false _這是默認值_ 當這個屬性是false或者沒有指定時，所有元素生成注釋時都會帶著生成時間。 | | | true 當這個屬性是true時，注釋中不會添加時間戳。 | ## 示例這個元素指定了我們不希望生成的注釋中包含時間戳: ``` <commentGenerator> <property name="suppressDate" value="true" /> </commentGenerator> ```