gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

changes (#24743)

Browse Source 
Changes in translations. It sounds better in Russian so.
This commit is contained in:
Vorkonolic
2018-11-05 20:57:29 +03:00
committed by Gregory Gubarev
parent 315f67f60b
commit b149191f80
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
guide/russian/documentation/index.md
View File

@ -4,10 +4,9 @@ localeTitle: Кодовая документация
---
## Кодовая документация
Документация по коду - это способ, которым разработчики пишут свой код для создания лучших версий своих функций. Документация кодов позволяет новичкам комфортно работать с обычаем конкретного модуля, функции и т. Д. Для определенного языка программирования. Перед отладкой кода всегда рекомендуется перейти с документацией, это поможет вам эффективно отлаживать. Например, вы должны быть в состоянии передать ваш код абсолютному новичку, и они должны иметь возможность следовать за комментариями, соответствующими именами переменных и кодом структурирования на расстоянии, читаемом образом.
Это может стать чрезвычайно важной идеей сделать привычку комментировать ваши функции, циклы и декларации и обрабатывать комментарии как часть исходного кода, так же, как и обычный код.
Документирование кода - это способ, которым разработчики пользуются для создания лучших версий своих функций. Документация кодов позволяет новичкам комфортно читать код, а другим членам команды легко заниматься его техническим обслуживанием. Перед отладкой кода всегда рекомендуется произвести документирование, это упростит отладку и сделает ее более эффективной. Например, вам нужно передать ваш код абсолютному новичку: они должны иметь возможность следовать за комментариями, соответствующими именами переменных и они должны видеть перед собой читаемый структирированный код, чтобы разобраться в нем.
Так что привычка комментировать ваши функции, циклы и декларации и обрабатывать комментарии как часть исходного кода может оказаться чрезывычайно полезной в некоторых ситуациях.
![Пример комментариев в реальном мире](https://cdn-images-1.medium.com/max/1620/1*Pyxsc7Uixbitv5myywaA_Q.jpeg)
#### Дополнительная информация:
#### Дополнительная информация: