13 lines
1.7 KiB
Markdown
13 lines
1.7 KiB
Markdown
---
|
||
title: Code documentation
|
||
localeTitle: Кодовая документация
|
||
---
|
||
## Кодовая документация
|
||
|
||
Документирование кода - это способ, которым разработчики пользуются для создания лучших версий своих функций. Документация кодов позволяет новичкам комфортно читать код, а другим членам команды легко заниматься его техническим обслуживанием. Перед отладкой кода всегда рекомендуется произвести документирование, это упростит отладку и сделает ее более эффективной. Например, вам нужно передать ваш код абсолютному новичку: они должны иметь возможность следовать за комментариями, соответствующими именами переменных и они должны видеть перед собой читаемый структирированный код, чтобы разобраться в нем.
|
||
Так что привычка комментировать ваши функции, циклы и декларации и обрабатывать комментарии как часть исходного кода может оказаться чрезывычайно полезной в некоторых ситуациях.
|
||
|
||
|
||
|
||
#### Дополнительная информация:
|