com.electronwill.nightconfig.core.serde.annotations

Annotation Type SerdeComment

@Repeatable(value=SerdeCommentsContainer.class)
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface SerdeComment

Defines the comment to write to the configuration for this field.

The comment is only added to the configuration we're serializing to if it's a CommentedConfig. When writing the configuration to a file (with a ConfigWriter), the comments are only written if that's supported by the configuration format.

Example

 class Player {
      @SerdeComment("The username of the Player, as reported by the database.")
     String username;
 }
 

Example: multiline comment

 class MyObject {
      @SerdeComment("First line of comment.")
      @SerdeComment("Second line of comment.")
     String someStringField;
 }
 

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	value

Element Detail

value

public abstract java.lang.String value