ExtensionCommentGenerator (mybatis-extension 1.3.0 API)

java.lang.Object
- org.mybatis.generator.internal.DefaultCommentGenerator
- - com.github.rexsheng.mybatis.plugin.ExtensionCommentGenerator

所有已实现的接口:

org.mybatis.generator.api.CommentGenerator
```
public class ExtensionCommentGenerator
extends org.mybatis.generator.internal.DefaultCommentGenerator
```
作者:

RexSheng 2020年10月12日下午11:14:02

构造器概要

构造器
构造器和说明

ExtensionCommentGenerator()

构造器
构造器和说明
`ExtensionCommentGenerator()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addClassAnnotation(org.mybatis.generator.api.dom.java.InnerClass innerClass, org.mybatis.generator.api.IntrospectedTable introspectedTable, Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)`
`void`	`addClassComment(org.mybatis.generator.api.dom.java.InnerClass innerClass, org.mybatis.generator.api.IntrospectedTable introspectedTable)`
`void`	`addClassComment(org.mybatis.generator.api.dom.java.InnerClass innerClass, org.mybatis.generator.api.IntrospectedTable introspectedTable, boolean markAsDoNotDelete)`
`void`	`addComment(org.mybatis.generator.api.dom.xml.XmlElement xmlElement)` Adds a suitable comment to warn users that the element was generated, and when it was generated.
`void`	`addConfigurationProperties(Properties properties)`
`void`	`addEnumComment(org.mybatis.generator.api.dom.java.InnerEnum innerEnum, org.mybatis.generator.api.IntrospectedTable introspectedTable)`
`void`	`addFieldAnnotation(org.mybatis.generator.api.dom.java.Field field, org.mybatis.generator.api.IntrospectedTable introspectedTable, org.mybatis.generator.api.IntrospectedColumn introspectedColumn, Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)`
`void`	`addFieldAnnotation(org.mybatis.generator.api.dom.java.Field field, org.mybatis.generator.api.IntrospectedTable introspectedTable, Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)`
`void`	`addFieldComment(org.mybatis.generator.api.dom.java.Field field, org.mybatis.generator.api.IntrospectedTable introspectedTable)` example中的字段
`void`	`addFieldComment(org.mybatis.generator.api.dom.java.Field field, org.mybatis.generator.api.IntrospectedTable introspectedTable, org.mybatis.generator.api.IntrospectedColumn introspectedColumn)`
`void`	`addFileComment(org.mybatis.generator.api.dom.kotlin.KotlinFile kotlinFile)`
`void`	`addGeneralMethodAnnotation(org.mybatis.generator.api.dom.java.Method method, org.mybatis.generator.api.IntrospectedTable introspectedTable, org.mybatis.generator.api.IntrospectedColumn introspectedColumn, Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)`
`void`	`addGeneralMethodAnnotation(org.mybatis.generator.api.dom.java.Method method, org.mybatis.generator.api.IntrospectedTable introspectedTable, Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)`
`void`	`addGeneralMethodComment(org.mybatis.generator.api.dom.java.Method method, org.mybatis.generator.api.IntrospectedTable introspectedTable)` example中的方法
`void`	`addGetterComment(org.mybatis.generator.api.dom.java.Method method, org.mybatis.generator.api.IntrospectedTable introspectedTable, org.mybatis.generator.api.IntrospectedColumn introspectedColumn)`
`protected void`	`addJavadocTag(org.mybatis.generator.api.dom.java.JavaElement javaElement, boolean markAsDoNotDelete)` This method adds the custom javadoc tag for.
`void`	`addJavaFileComment(org.mybatis.generator.api.dom.java.CompilationUnit compilationUnit)`
`void`	`addModelClassComment(org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass, org.mybatis.generator.api.IntrospectedTable introspectedTable)` entity生成的时候
`void`	`addRootComment(org.mybatis.generator.api.dom.xml.XmlElement rootElement)`
`void`	`addSetterComment(org.mybatis.generator.api.dom.java.Method method, org.mybatis.generator.api.IntrospectedTable introspectedTable, org.mybatis.generator.api.IntrospectedColumn introspectedColumn)`
`protected String`	`getDateString()` Returns a formated date string to include in the Javadoc tag and XML comments.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.mybatis.generator.api.CommentGenerator
addGeneralFunctionComment, addGeneralPropertyComment, addModelClassComment

- 构造器详细资料
  - ExtensionCommentGenerator
```
public ExtensionCommentGenerator()
```
- 方法详细资料
  - addJavaFileComment
```
public void addJavaFileComment(org.mybatis.generator.api.dom.java.CompilationUnit compilationUnit)
```
    指定者:
    
    addJavaFileComment 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addJavaFileComment 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addComment
```
public void addComment(org.mybatis.generator.api.dom.xml.XmlElement xmlElement)
```
    Adds a suitable comment to warn users that the element was generated, and when it was generated.
    
    指定者:
    
    addComment 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addComment 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
    
    参数:
    
    xmlElement - the xml element
  - addRootComment
```
public void addRootComment(org.mybatis.generator.api.dom.xml.XmlElement rootElement)
```
    指定者:
    
    addRootComment 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addRootComment 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addConfigurationProperties
```
public void addConfigurationProperties(Properties properties)
```
    指定者:
    
    addConfigurationProperties 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addConfigurationProperties 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addJavadocTag
```
protected void addJavadocTag(org.mybatis.generator.api.dom.java.JavaElement javaElement,
                             boolean markAsDoNotDelete)
```
    This method adds the custom javadoc tag for. You may do nothing if you do not wish to include the Javadoc tag - however, if you do not include the Javadoc tag then the Java merge capability of the eclipse plugin will break.
    
    覆盖:
    
    addJavadocTag 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
    
    参数:
    
    javaElement - the java element
    
    markAsDoNotDelete - the mark as do not delete
  - getDateString
```
protected String getDateString()
```
    Returns a formated date string to include in the Javadoc tag and XML comments. You may return null if you do not want the date in these documentation elements.
    
    覆盖:
    
    getDateString 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
    
    返回:
    
    a string representing the current timestamp, or null
  - addClassComment
```
public void addClassComment(org.mybatis.generator.api.dom.java.InnerClass innerClass,
                            org.mybatis.generator.api.IntrospectedTable introspectedTable)
```
    指定者:
    
    addClassComment 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addClassComment 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addClassComment
```
public void addClassComment(org.mybatis.generator.api.dom.java.InnerClass innerClass,
                            org.mybatis.generator.api.IntrospectedTable introspectedTable,
                            boolean markAsDoNotDelete)
```
    指定者:
    
    addClassComment 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addClassComment 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addModelClassComment
```
public void addModelClassComment(org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass,
                                 org.mybatis.generator.api.IntrospectedTable introspectedTable)
```
    entity生成的时候
    
    指定者:
    
    addModelClassComment 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addModelClassComment 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addEnumComment
```
public void addEnumComment(org.mybatis.generator.api.dom.java.InnerEnum innerEnum,
                           org.mybatis.generator.api.IntrospectedTable introspectedTable)
```
    指定者:
    
    addEnumComment 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addEnumComment 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addFieldComment
```
public void addFieldComment(org.mybatis.generator.api.dom.java.Field field,
                            org.mybatis.generator.api.IntrospectedTable introspectedTable,
                            org.mybatis.generator.api.IntrospectedColumn introspectedColumn)
```
    指定者:
    
    addFieldComment 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addFieldComment 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addFieldComment
```
public void addFieldComment(org.mybatis.generator.api.dom.java.Field field,
                            org.mybatis.generator.api.IntrospectedTable introspectedTable)
```
    example中的字段
    
    指定者:
    
    addFieldComment 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addFieldComment 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addGeneralMethodComment
```
public void addGeneralMethodComment(org.mybatis.generator.api.dom.java.Method method,
                                    org.mybatis.generator.api.IntrospectedTable introspectedTable)
```
    example中的方法
    
    指定者:
    
    addGeneralMethodComment 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addGeneralMethodComment 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addGetterComment
```
public void addGetterComment(org.mybatis.generator.api.dom.java.Method method,
                             org.mybatis.generator.api.IntrospectedTable introspectedTable,
                             org.mybatis.generator.api.IntrospectedColumn introspectedColumn)
```
    指定者:
    
    addGetterComment 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addGetterComment 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addSetterComment
```
public void addSetterComment(org.mybatis.generator.api.dom.java.Method method,
                             org.mybatis.generator.api.IntrospectedTable introspectedTable,
                             org.mybatis.generator.api.IntrospectedColumn introspectedColumn)
```
    指定者:
    
    addSetterComment 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addSetterComment 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addGeneralMethodAnnotation
```
public void addGeneralMethodAnnotation(org.mybatis.generator.api.dom.java.Method method,
                                       org.mybatis.generator.api.IntrospectedTable introspectedTable,
                                       Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)
```
    指定者:
    
    addGeneralMethodAnnotation 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addGeneralMethodAnnotation 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addGeneralMethodAnnotation
```
public void addGeneralMethodAnnotation(org.mybatis.generator.api.dom.java.Method method,
                                       org.mybatis.generator.api.IntrospectedTable introspectedTable,
                                       org.mybatis.generator.api.IntrospectedColumn introspectedColumn,
                                       Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)
```
    指定者:
    
    addGeneralMethodAnnotation 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addGeneralMethodAnnotation 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addFieldAnnotation
```
public void addFieldAnnotation(org.mybatis.generator.api.dom.java.Field field,
                               org.mybatis.generator.api.IntrospectedTable introspectedTable,
                               Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)
```
    指定者:
    
    addFieldAnnotation 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addFieldAnnotation 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addFieldAnnotation
```
public void addFieldAnnotation(org.mybatis.generator.api.dom.java.Field field,
                               org.mybatis.generator.api.IntrospectedTable introspectedTable,
                               org.mybatis.generator.api.IntrospectedColumn introspectedColumn,
                               Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)
```
    指定者:
    
    addFieldAnnotation 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addFieldAnnotation 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addClassAnnotation
```
public void addClassAnnotation(org.mybatis.generator.api.dom.java.InnerClass innerClass,
                               org.mybatis.generator.api.IntrospectedTable introspectedTable,
                               Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)
```
    指定者:
    
    addClassAnnotation 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addClassAnnotation 在类中 org.mybatis.generator.internal.DefaultCommentGenerator
  - addFileComment
```
public void addFileComment(org.mybatis.generator.api.dom.kotlin.KotlinFile kotlinFile)
```
    指定者:
    
    addFileComment 在接口中 org.mybatis.generator.api.CommentGenerator
    
    覆盖:
    
    addFileComment 在类中 org.mybatis.generator.internal.DefaultCommentGenerator

类 ExtensionCommentGenerator

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 org.mybatis.generator.api.CommentGenerator

构造器详细资料

ExtensionCommentGenerator

方法详细资料

addJavaFileComment

addComment

addRootComment

addConfigurationProperties

addJavadocTag

getDateString

addClassComment

addClassComment

addModelClassComment

addEnumComment

addFieldComment

addFieldComment

addGeneralMethodComment

addGetterComment

addSetterComment

addGeneralMethodAnnotation

addGeneralMethodAnnotation

addFieldAnnotation

addFieldAnnotation

addClassAnnotation

addFileComment