org.mybatis.generator.api.CommentGenerator |
![]() |
Implementations of this interface are used to generate comments for the various artifacts.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
This method should add a suitable comment as a child element of the
specified xmlElement to warn users that the element was generated and is
subject to regeneration.
| |||||||||||
Adds properties for this instance from any properties configured in the
CommentGenerator configuration.
| |||||||||||
This method should add a Javadoc comment to the specified field.
| |||||||||||
This method is called to add a file level comment to a generated java
file.
| |||||||||||
This method is called to add a comment as the first child of the root
element.
| |||||||||||
This method should add a suitable comment as a child element of the specified xmlElement to warn users that the element was generated and is subject to regeneration.
Adds properties for this instance from any properties configured in the CommentGenerator configuration. This method will be called before any of the other methods.
properties | All properties from the configuration |
---|
This method should add a Javadoc comment to the specified field. The field is related to the specified table and is used to hold the value of the specified column.
Important: This method should add a the nonstandard JavaDoc tag "@mbggenerated" to the comment. Without this tag, the Eclipse based Java merge feature will fail.
This method is called to add a file level comment to a generated java file. This method could be used to add a general file comment (such as a copyright notice). However, note that the Java file merge function in Eclipse does not deal with this comment. If you run the generator repeatedly, you will only retain the comment from the initial run.
The default implementation does nothing.
This method is called to add a comment as the first child of the root element. This method could be used to add a general file comment (such as a copyright notice). However, note that the XML file merge function does not deal with this comment. If you run the generator repeatedly, you will only retain the comment from the initial run.
The default implementation does nothing.