Notas do tradutor

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

Obsoleto

Esta documentação cobre o CLI legado (v0). O CLI atual é o v1. Veja a documentação atual da CLI

Alguns formatos de arquivo oferecem suporte a comentários inline, que a CLI da Lingo.dev inclui nas solicitações de tradução. Esses comentários dão contexto ao modelo de IA — desambiguando termos, definindo o tom ou explicando onde o conteúdo aparece na interface.

Por que as notas do tradutor importam#

A palavra "Records" pode se referir a prontuários médicos, discos de música ou registros de banco de dados. Sem contexto, o modelo de IA precisa adivinhar. Uma nota do tradutor elimina essa ambiguidade:

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

O comentário é enviado junto com a string na solicitação de tradução, guiando o modelo para a interpretação correta.

Formatos compatíveis#

No momento, as notas do tradutor são compatíveis com:

FormatoTipo de bucketSintaxe do comentário
JSONCjsonc// comment acima da chave
Catálogos de Strings do Xcodexcode-xcstringsCampo de comentário no arquivo .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#

Notas do tradutor eficazes descrevem contextos que não ficam óbvios só pela string:

EficazPor quê
// Button label in checkout flowInforma ao modelo onde o texto aparece na interface e o nível de concisão esperado
// "Set" means a collection, not the verbDesambigua uma palavra polissêmica
// Formal tone - displayed in legal footerDefine o nível de formalidade esperado

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

Próximos passos#