Package cc.carm.lib.configuration.annotation

Annotation Type HeaderComments

@Target({TYPE,FIELD})
@Retention(RUNTIME)
public @interface HeaderComments

Header Comments. Add a comment to the top of the corresponding configuration for easy reading and viewing.

e.g.

 # The first line of the comment
 # The second line of the comment
 foo: "bar"
 

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
@NotNull java.lang.String[]	value	If the content of the note is 0, it will be treated as a blank line.

Element Detail

value

@NotNull
@NotNull java.lang.String[] value

If the content of the note is 0, it will be treated as a blank line.

e.g. {"foo","","bar"} Will be set as

 # foo

 # bar
 foo: "bar"
 

Returns:

The content of this comment

Default:

{""}