Примечания для переводчика
Устаревшее
Некоторые форматы файлов поддерживают встроенные комментарии, которые CLI Lingo.dev включает в запросы на перевод. Они дают ИИ-модели контекст: уточняют значение терминов, задают тон или поясняют, где текст появляется в интерфейсе.
Почему примечания для переводчика важны#
Слово "Records" может означать медицинские карты, музыкальные записи или записи в базе данных. Без контекста ИИ-модели приходится гадать. Примечание для переводчика снимает эту неоднозначность:
{
// Medical context: refers to patient medical records
"records": "Records"
}Комментарий отправляется вместе со строкой в запросе на перевод и помогает модели выбрать верную интерпретацию.
Поддерживаемые форматы#
Сейчас примечания для переводчика поддерживаются в следующих форматах:
| Формат | Тип bucket | Синтаксис комментариев |
|---|---|---|
| JSONC | jsonc | // comment над ключом |
| Каталоги строк Xcode | xcode-xcstrings | Поле комментария в файле .xcstrings |
Пример 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"
}Чтобы использовать JSONC, настройте тип bucket jsonc в файле i18n.json:
{
"buckets": {
"jsonc": {
"include": ["locales/[locale].jsonc"]
}
}
}Как писать полезные примечания#
Полезные примечания для переводчика описывают контекст, который неочевиден из самой строки:
| Хорошо | Почему |
|---|---|
// Button label in checkout flow | Подсказывает модели, где текст расположен в интерфейсе и что он должен быть кратким |
// "Set" means a collection, not the verb | Снимает неоднозначность многозначного слова |
// Formal tone - displayed in legal footer | Задаёт нужный регистр речи |
Примечания, которые просто повторяют саму строку (// This says Welcome), пользы не приносят.