如何在Flutter Easy Localization翻译文件中添加注释行？

JSON本身原生不支持注释，但针对Easy Localization包，有几种实用的变通方案：

• 用特殊命名的键存注释
  在JSON里新增一个和业务键区分开的注释键，比如统一用__comment_前缀，Easy Localization不会读取这些非业务键，完全不影响翻译功能：

  {
    "__comment_home_section": "首页区域的所有文案",
    "home_title": "首页",
    "home_btn_login": "登录",
    "__comment_profile_section": "个人中心相关文案",
    "profile_name": "我的名字"
  }
  

• 改用JSON5格式（支持原生注释）
  Easy Localization支持JSON5格式，这种格式允许单行//和多行/* */注释。只需要两步：

  1. 把翻译文件的后缀改成.json5，比如zh-CN.json5，然后直接写注释：

     {
       // 首页标题，在顶部导航栏显示
       "home_title": "首页",
       /* 登录按钮文案
          点击后跳转到登录页面 */
       "home_btn_login": "登录"
     }
     

  2. 初始化Easy Localization时指定用Json5AssetLoader加载：

     EasyLocalization(
       supportedLocales: [Locale('en'), Locale('zh_CN')],
       path: 'assets/translations',
       assetLoader: Json5AssetLoader(),
     )
     

• 单独维护注释文档
  如果不想修改现有JSON文件结构，可以给每个翻译文件配一个对应的注释文档，比如zh-CN_comments.md，里面按翻译键逐一写说明，适合大型项目统一管理注释内容。

内容的提问来源于stack exchange，提问作者Giovanni