Annotation Interface Comment

@Target({FIELD,TYPE}) @Retention(RUNTIME) @Documented public @interface Comment
Adds a comment to a configuration field in the generated YAML/JSONC/TOML file. Comments are ignored for formats that do not support them.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    Comment text.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    above
    Whether to place comment above (true) or inline (false).

  • Element Details

    • value

      String value
      Comment text. Can be multiline.
      Returns:
      the comment text

    • above

      boolean above
      Whether to place comment above (true) or inline (false).
      Returns:
      true for above, false for inline
      Default:
      true