翻訳メモ

文字列だけでは、意味が曖昧になりがちです。たとえば "Records" は、診療記録、レコード、あるいはデータベースの行を指すことがあります。JSONCソースファイルでは、キーの上に書いたコメントがコンテキストとしてエンジンに送られるため、意図した意味で翻訳できます。

{
  // Medical context: patient medical records
  "records": "Records"
}

コメントが出力に含まれることはありません。翻訳の方向づけに使われるだけです。

メモが使える場所#

翻訳メモは、JSONC（.jsonc）ソースファイルから読み取られます。files[] エントリでそのファイルを指定してください。

{ "pattern": "content/en/app.jsonc" }

JSON（.json）にはコメントを書けないため、メモを持たせることはできません。メモを使いたい場合は、そのファイルにJSONCを使ってください。

従来のCLIをお使いでしたか？ 以前は Xcode String Catalog（.xcstrings）からもメモを読み取れました。ただし、この形式は現在のCLIではサポートされていないため、現在コンテキストを添える方法はJSONCコメントです。

役立つメモの書き方#

良いメモは、文字列そのものだけでは伝わらないコンテキストを補います。

{
  // Button in the checkout flow — keep it short
  "checkout.pay": "Pay now",

  // "Set" here means a collection, not the verb
  "library.set": "Set",

  // Formal tone — shown in the legal footer
  "footer.terms": "Terms of Service"
}

文字列を言い換えているだけのメモ（// This says Welcome）は意味がないので、付けなくてかまいません。

メモとエンジン設定の使い分け#

翻訳メモは、ソース内の各文字列に対して付けるものです。一方、ロケール全体に適用したいルール——用語、トーン、ブランドボイスなど——は、各キーに毎回メモを書くのではなく、エンジン側で設定してください。