среда, ноября 28, 2007

Кодинг: про комментирование кода

Комментирование - это неотъемлемая часть процесса программирования.
Естественно все это знают и каждый сознательный программист им занимается.
Когда я только начинал заниматься программированием объём комментариев превышал объём самого кода. Видимо это было связано с тем, что учась программировать я использовал комментарии не совсем по назначению, т.е. использовал их как средство запоминания некоторых функции, а не для указания предназначения эти функций в коде.

Например, так:
$file = fopen("file.txt"); // Функция получает указатель на файл

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

И вот заметил такую штуку за собой - я практически перестал использовать комментарии однострочные (ну тоесть комментарии справа от кода). Вот уж не знаю с чем это связано, но факт остаётся фактом, получается примерно так:

Было раньше: $file = fopen("file.txt"); // Функция получает указатель на файл
Пишу сейчас:
// Функция получает указатель на файл
$file = fopen("file.txt");

Причём делаю я это совершенно бессознательно, наверное, так глазу приятнее.

Комментариев нет: