|
2 | 2 |
|
3 | 3 | ## Оформление |
4 | 4 |
|
5 | | -- Символ отступа — пробел. Табуляция в файлах с расширением`.xml` спровоцирует ошибку. |
| 5 | +- Символ отступа — пробел; табуляция в файлах с расширением`.xml` спровоцирует ошибку. В XML-документах пробелы в конце строк тоже вызовут ошибку. |
6 | 6 | - В документации пишут букву `ё`, чтобы исключить риск двойного прочтения. |
| 7 | +- При оформлении текстов соблюдают правила типографики: пишут тире, кавычки-ёлочки, сокращения в конструкциях наподобие `т. п.` или `т. д.` разделяют пробелом, соблюдают правила наращения числительных и т. д. |
7 | 8 |
|
8 | 9 | ## Рекомендации по переводу |
9 | 10 |
|
10 | | -Комментарии к коду требуется переводить; |
11 | | -описание вывода наподобие `echo "You reload page $num times";` — тоже переводится. |
| 11 | +Комментарии к примерам кода переводят на русский язык; |
| 12 | +описание вывода наподобие `echo "You reload page $num times";` — тоже переводится. Текст ошибок и исключений не переводится. |
12 | 13 |
|
13 | 14 | Исключение: английские слова в коде не переводятся, если перевод на русский язык изменит поведение функции, например, |
14 | 15 | `strtolower("Alex") === "alex"`, но `strtolower("Алексей") !== "алексей"`. |
|
22 | 23 | который описывает рекомендация [PER](https://www.php-fig.org/per/coding-style/), |
23 | 24 | даже если потребуется изменить форматирование примера оригинальной документации. |
24 | 25 |
|
25 | | -Оригинальный текст переводят предельно точно, отступления допускаются только для сохранения семантики, если буквальный перевод исказит смысл. |
26 | | -При неточных или ошибочных формулировках в исходной документации вначале через запрос на слияние исправляют английскую версию, а только потом обновляют русскую. |
| 26 | +Оригинальный текст переводят _предельно точно,_ отступления допускаются только для сохранения семантики, если буквальный перевод исказит смысл. |
| 27 | +При неточных или ошибочных формулировках в исходной документации вначале исправляют английскую версию путём отправки запроса на слияние, а только потом обновляют русскую. |
27 | 28 |
|
28 | 29 | ## Актуализация перевода |
29 | 30 |
|
@@ -245,43 +246,41 @@ php phd/render.php --docbook doc-base/.manual.xml --package PHP --format xhtml |
245 | 246 | | PHP_VERSION | Константа PHP_VERSION | |
246 | 247 | | `var_dump()` | Функция `var_dump()` | |
247 | 248 |
|
248 | | -Одного уточнения хватит, если в предложении или коротком абзаце термин встречается больше одного раза, по смыслу. |
| 249 | +Одного уточнения достаточно, если в предложении или коротком абзаце термин встречается больше одного раза, по смыслу. |
249 | 250 | При добавлении уточняющего слова дайте точное определение. Для термина `$_SERVER` доступны |
250 | 251 | уточнения: «Переменная $_SERVER», «Глобальная переменная $_SERVER» или «Суперглобальная переменная $_SERVER» — лучше предпочесть последнее. |
251 | 252 |
|
252 | 253 | ## Параметры и аргументы |
253 | 254 |
|
254 | | -Параметр — член функции, который принадлежит функции, составляет сигнатуру функции или метода. |
| 255 | +Параметр — неотъемлемая часть сигнатуры функции или метода. |
255 | 256 | Аргумент — значение, которое передают в функцию или метод «снаружи», чтобы определить значение параметра. |
256 | | -Аргумент допускается передавать в функцию, передать в функцию параметр — нельзя, поскольку он уже находится «внутри» функции. |
| 257 | +Аргумент допускается передавать в функцию, передать параметр — невозможно, поскольку параметр — «внутренняя часть» функции. |
257 | 258 |
|
258 | | -Участники перевода руководствуются этими разъяснениями, даже если в оригинальной документации «параметры» |
| 259 | +Участники перевода руководствуются логикой передачи аргументов и приёма аргументов параметрами функции, даже если в оригинальной документации «параметры» |
259 | 260 | и «аргументы» употребили некорректно. |
260 | 261 |
|
261 | 262 | ## Скобки |
262 | 263 |
|
263 | | -Скобки затрудняют и замедляют чтение. Читатель «спотыкается» о скобки. Но без скобок нельзя обойтись. «В скобки заключают |
264 | | -слова и предложения, вставляемые в предложение с целью пояснения или дополнения высказываемой мысли, а также |
265 | | -для каких-либо добавочных замечаний» — гласят правила русского языка. |
| 264 | +Пояснения или добавочные замечания в предложении стараются не обрамлять скобками; скобки затрудняют и замедляют чтение, заставляют читателя «спотыкаться». Лучше вынести высказывание за скобки или в отдельное предложение. |
266 | 265 |
|
267 | | -При переводе <em>не нужно</em> брать в скобки названия параметров. |
| 266 | +При переводе названия параметров _не берут_ в скобки. |
268 | 267 |
|
269 | 268 | Например: |
270 | 269 |
|
271 | 270 | > Функция больше не поддерживает передачу разделителя `<parameter>separator</parameter>` после массива `<parameter>array</parameter>`. |
272 | 271 |
|
273 | 272 | В примере названия параметров — полноценные и равноправные члены предложения. |
274 | 273 |
|
275 | | -Названия типов <em>нужно</em> брать в скобки. |
| 274 | +При этом названия типов _обрамляют_ скобками. |
276 | 275 |
|
277 | 276 | Например: |
278 | 277 |
|
279 | 278 | > Функция возвращает строку (`<type>string</type>`). |
280 | 279 |
|
281 | | -В этом примере слово string (вместе с тегами) взяли в скобки, потому что слово поясняет, |
| 280 | +В примере слово `string` вместе с тегами взяли в скобки, потому что слово поясняет, |
282 | 281 | что «строка», кроме словарного значения, означает тип данных. |
283 | 282 |
|
284 | | -Старайтесь избавиться от скобок, если уместно (если это не часть примера или выражения и т. д.), |
| 283 | +Старайтесь избавляться от скобок, если уместно и если скобки — не часть примера или выражения, |
285 | 284 | даже если в исходной документации слова или предложения указали в скобках. |
286 | 285 |
|
287 | 286 | Точку ставят после закрывающей скобки, если слова в скобках — часть предложения (как в этом примере). |
|
0 commit comments