Une chaîne, prise isolément, est souvent ambiguë. « Records » peut désigner des dossiers médicaux, des disques ou des lignes de base de données. Dans les fichiers source JSONC, un commentaire au-dessus d’une clé est transmis au moteur comme contexte, afin qu’il choisisse le bon sens :
{
// Medical context: patient medical records
"records": "Records"
}Le commentaire n’apparaît jamais dans la sortie : il sert uniquement à guider la traduction.
Où les notes sont prises en charge#
Les notes de traduction sont lues depuis les fichiers source JSONC (.jsonc). Faites pointer une entrée files[] vers l’un d’eux :
{ "pattern": "content/en/app.jsonc" }Le format JSON (.json) ne prend pas en charge les commentaires, il ne peut donc pas contenir de notes. Si vous en avez besoin, utilisez JSONC pour ce fichier.
Vous utilisiez l’ancien CLI ? Il lisait aussi les notes depuis les catalogues de chaînes Xcode (.xcstrings). Ce format n’est pas pris en charge par le CLI actuel ; aujourd’hui, les commentaires JSONC sont donc la bonne façon d’ajouter du contexte.
Comment rédiger des notes utiles#
Une bonne note apporte un contexte que la chaîne seule ne donne pas :
{
// 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"
}| Note | Pourquoi c’est utile |
|---|---|
// Appears in the top nav | indique au moteur où la chaîne apparaît et le niveau de concision attendu |
// "Light" is the theme, not weight | désambiguïse un mot qui a plusieurs sens |
// Formal register | donne le ton à adopter |
Les notes qui se contentent de répéter la chaîne (// This says Welcome) n’apportent rien : mieux vaut s’en passer.
Notes vs. configuration du moteur#
Les notes de traduction s’appliquent chaîne par chaîne, directement dans votre source. Pour les règles qui valent pour toute une langue — terminologie, ton, voix de marque — définissez-les plutôt dans le moteur, afin qu’elles s’appliquent partout sans avoir à ajouter une note sur chaque clé.
