From b149191f800bb659fb58f449c23e24a8664403b1 Mon Sep 17 00:00:00 2001 From: Vorkonolic <44326775+Vorkonolic@users.noreply.github.com> Date: Mon, 5 Nov 2018 20:57:29 +0300 Subject: [PATCH] changes (#24743) Changes in translations. It sounds better in Russian so. --- guide/russian/documentation/index.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/guide/russian/documentation/index.md b/guide/russian/documentation/index.md index 39dcd6cb52..5927a487c6 100644 --- a/guide/russian/documentation/index.md +++ b/guide/russian/documentation/index.md @@ -4,10 +4,9 @@ localeTitle: Кодовая документация --- ## Кодовая документация -Документация по коду - это способ, которым разработчики пишут свой код для создания лучших версий своих функций. Документация кодов позволяет новичкам комфортно работать с обычаем конкретного модуля, функции и т. Д. Для определенного языка программирования. Перед отладкой кода всегда рекомендуется перейти с документацией, это поможет вам эффективно отлаживать. Например, вы должны быть в состоянии передать ваш код абсолютному новичку, и они должны иметь возможность следовать за комментариями, соответствующими именами переменных и кодом структурирования на расстоянии, читаемом образом. - -Это может стать чрезвычайно важной идеей сделать привычку комментировать ваши функции, циклы и декларации и обрабатывать комментарии как часть исходного кода, так же, как и обычный код. +Документирование кода - это способ, которым разработчики пользуются для создания лучших версий своих функций. Документация кодов позволяет новичкам комфортно читать код, а другим членам команды легко заниматься его техническим обслуживанием. Перед отладкой кода всегда рекомендуется произвести документирование, это упростит отладку и сделает ее более эффективной. Например, вам нужно передать ваш код абсолютному новичку: они должны иметь возможность следовать за комментариями, соответствующими именами переменных и они должны видеть перед собой читаемый структирированный код, чтобы разобраться в нем. +Так что привычка комментировать ваши функции, циклы и декларации и обрабатывать комментарии как часть исходного кода может оказаться чрезывычайно полезной в некоторых ситуациях. ![Пример комментариев в реальном мире](https://cdn-images-1.medium.com/max/1620/1*Pyxsc7Uixbitv5myywaA_Q.jpeg) -#### Дополнительная информация: \ No newline at end of file +#### Дополнительная информация: