Сегодня я усвоил важный урок о том, как делать что-то, чтобы помочь себе в будущем. Я пересматривал некоторые старые проекты, чистил их и убеждался, что они работают правильно, и быстро понял, что я не так хорошо знаком с этими приложениями, как когда работал с ними ежедневно (ДУХ). Чтобы добавить в приложения некоторые очень незначительные функции, мне сначала пришлось потратить довольно много времени на повторное ознакомление с функциями, которые я написал, и тем, что они делают, чего, оглядываясь назад, я мог бы легко избежать. Возьмите этот блок кода, например:
Я потратил значительное количество времени, отслеживая, где эти функции вступают в игру, различая их между функциями с похожими именами, и после разговора с другом понял, что если бы я использовал комментарии, чтобы объяснить, для какой цели они служат, я мог бы ускорить работу. Я занимался этим проектом.
Теперь взгляните на этот обновленный блок кода, включая комментарии, объясняющие, помимо конкретных имен функций, что делает код:
Включение комментариев в ваш код — это быстрый способ облегчить себе жизнь, когда вы возвращаетесь к проектам, которые вы давно не просматривали. Мало того, описательность вашего кода также поможет вашим коллегам или коллегам-программистам, которые могут в какой-то момент взглянуть на ваш код.
Сегодня я узнал, что, хотя кажется раздражающим тратить время на написание комментариев во время написания кода, это небольшое усилие с огромной пользой. Будущее вы будете благодарны вам!
