13 lines
1.7 KiB
Markdown
13 lines
1.7 KiB
Markdown
---
|
||
title: Code documentation
|
||
localeTitle: Кодовая документация
|
||
---
|
||
## Кодовая документация
|
||
|
||
Документация по коду - это способ, которым разработчики пишут свой код для создания лучших версий своих функций. Документация кодов позволяет новичкам комфортно работать с обычаем конкретного модуля, функции и т. Д. Для определенного языка программирования. Перед отладкой кода всегда рекомендуется перейти с документацией, это поможет вам эффективно отлаживать. Например, вы должны быть в состоянии передать ваш код абсолютному новичку, и они должны иметь возможность следовать за комментариями, соответствующими именами переменных и кодом структурирования на расстоянии, читаемом образом.
|
||
|
||
Это может стать чрезвычайно важной идеей сделать привычку комментировать ваши функции, циклы и декларации и обрабатывать комментарии как часть исходного кода, так же, как и обычный код.
|
||
|
||
![Пример комментариев в реальном мире](https://cdn-images-1.medium.com/max/1620/1*Pyxsc7Uixbitv5myywaA_Q.jpeg)
|
||
|
||
#### Дополнительная информация: |