Comments

Comments are an integral part of any YAML experience. They can make or break how easy your configs are. Comments can be declared the @Comment annotation. Comments can be attached to both the class declaration (called a header comment) or to individual nodes.

@Config("config.yml")
@Comment({
    "This is an example header comment!"
})
public class DefaultConfig {
    @Comment({
        "The name of the person."
    })
    @Node
    public final String name = "John Doe";

    @Comment({
        "The email for the person."
    })
    @Node(1)
    public final String email = "[email protected]";

    public static DefaultConfig New() {
        return DeclarativeYAML.From(DefaultConfig.class)
    }
}

# This is an example header comment!

# The name of the person.
name: "John Doe"

# The email for the person
email: "[email protected]"

The @Comment annotation takes an array of strings. Hashtags (#) are not required when entering a comment, they'll be added later. Though, if you do add a hashtag, dYAML won't touch the string.

Comment Injecting

You can dynamically replace parts of a comment with your own text. Lets take the following example where we've defined a key in our comment called persons_name.

@Config("config.yml")
public class DefaultConfig {
    @Comment({
        "The email for {persons_name}."
    })
    @Node
    public final String email = "[email protected]";

    public static DefaultConfig New() {
        return DeclarativeYAML.From(DefaultConfig.class)
    }
}

We can adjust what gets printed here by editing the Printer.

@Config("config.yml")
public class DefaultConfig {
    @Comment({
        "The email for {persons_name}."
    })
    @Node
    public final String email = "[email protected]";

    public static DefaultConfig New(String name) {
        Printer printer = new Printer().commentReplacements(Map.of("persons_name", name));
        return DeclarativeYAML.From(DefaultConfig.class)
    }
}

By running DefaultConfig.New("John Doe") a config with the following data will be generated.

# The email for John Doe.
email: "[email protected]"