Документирование кода

Не забывайте о важности документирования вашего кода. Благодаря ему в вашем творении смогут разобраться не только другие разработчики, но и вы сами, когда через пару месяцев когда у вас все вылетит из головы.

Зачем документация кода

Сделайте свою жизнь и жизнь своих коллег проще. Избавьтесь от изучения кода там, где этого можно избежать,, что делает этот код, за что он отвечает. Даже если вы только учитесь, начните развивать эту привычку — чем раньше, тем лучше. Всегда представляйте, что вы создаете код для крупной компании, над которой работает целая команда специалистов.

Документация в коде захламляет код

Да, это определенно недостаток. Чтение интерфейса класса усложняется, чрезмерное количество комментариев в блоках кода вызывает шум. Однако при соблюдении рекомендаций это даст один большой плюс — программисту не придется лезть в отдельное место и искать описание этого метода/класса/структуры/чего угодно.

Репост статьи

26 марта 2022 г.

Комментарии