Notas para tradutores

Max PrilutskiyCEO e cofundadorAtualizado em: há 3 meses · 2 min de leitura

Descontinuado

Esta documentação abrange a CLI antiga (v0). A versão atual da CLI é a v1. Ver a documentação atual da CLI

Alguns formatos de ficheiro suportam comentários inline que a CLI do Lingo.dev inclui nos pedidos de tradução. Estes comentários dão contexto ao modelo de IA — desambiguam termos, definem o tom ou indicam onde o conteúdo aparece na interface.

Porque é que as notas para tradutores são importantes#

A palavra "Records" pode referir-se a registos clínicos, discos de música ou registos de base de dados. Sem contexto, o modelo de IA tem de adivinhar. Uma nota para tradutores elimina essa ambiguidade:

jsonc
{
  // Medical context: refers to patient medical records
  "records": "Records"
}

O comentário é enviado juntamente com a string no pedido de tradução, orientando o modelo para a interpretação correta.

Formatos suportados#

Atualmente, as notas para tradutores são suportadas em:

FormatoTipo de bucketSintaxe de comentário
JSONCjsonc// comment acima da chave
Catálogos de strings do Xcodexcode-xcstringsCampo de comentário no ficheiro .xcstrings

Exemplo em JSONC#

jsonc
{
  // Navigation menu item - appears in the top header bar
  "nav.home": "Home",

  // Button label - triggers form submission, keep it short
  "form.submit": "Submit",

  // "Light" refers to the visual theme, not weight or illumination
  "settings.theme.light": "Light"
}

Para usar JSONC, configure o tipo de bucket jsonc no seu i18n.json:

json
{
  "buckets": {
    "jsonc": {
      "include": ["locales/[locale].jsonc"]
    }
  }
}

Como escrever notas eficazes#

As notas para tradutores mais eficazes descrevem contexto que não é evidente na própria string:

EficazPorquê
// Button label in checkout flowIndica ao modelo onde aparece na interface e o nível de brevidade esperado
// "Set" means a collection, not the verbDesambigua uma palavra polissémica
// Formal tone - displayed in legal footerDefine o registo esperado

Notas que apenas repetem a própria string (// This says Welcome) não acrescentam valor.

Próximos passos#