Annotation Type HeaderComment


  • @Target({TYPE,FIELD})
    @Retention(RUNTIME)
    public @interface HeaderComment
    顶部注释,用于给对应配置的顶部添加注释,便于使用者阅读查看。

    如:

     # 注释第一行
     # 注释第二行
     foo: "bar"
     
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      @NotNull java.lang.String[] value
      注释内容,若内容长度为0则会视为一个空行。
    • Element Detail

      • value

        @NotNull
        @NotNull java.lang.String[] value
        注释内容,若内容长度为0则会视为一个空行。

        {"foo","","bar"} 会被添加为

         # foo
        
         # bar
         foo: "bar"
         
        Returns:
        注释内容
        Default:
        {""}