Другие языки программирования и технологии

Язык Си. Такие комментарии нормально?

if( (i%2) && i>= gap && i<sq-gap ) //если i – четное в диапозоне от gap до sq-gap
Или какие комменты лучше отражают суть происходящего? Спасибо!!! Это if внутри цикла for находится, если это важно.
1. Комментируй свой код так, чтобы через пару лет ТЫ САМ врубился, что и как. Можешь даже картинку нарисовать, если считаешь, что тебе это нужно. Здесь всё очень просто.
2. Выработай стиль: отступы, пробелы, названия функций и переменных (типа верблюд или змея и т. п.), переносы и т. д. Это гораздо ВАЖНЕЕ, чем комментирование. Хороший стиль вырабатывается годами. Без преувеличения можно сказать, что это показатель твоего скилла. Посмотри готовые руководства по стилю, если не можешь придумать сам.
Андрей Зиновьев
Андрей Зиновьев
26 548
Лучший ответ
Дмитрий Павловский Спасибо! отдельное спасибо за руководства по стилю, обязательно посмотрю, а то у меня даже назвать переменную или функцию -проблема.
Нет, не нормально.

Бессмысленно комментировать то, что и так очевидно из кода. Комментировать надо назначение подпрограмм и не очевидные особенности алгоритмов.

А комментарии в духе КО - никому не нужное нагромождение текста, показывающее, что ты считаешь окружающих идиотами.

В нормальном коде комментарии практически не требуется: 90% действий, выполняемых кодом, понятны из названий переменных, подпрограмм, типов...
Stepan Bendera
Stepan Bendera
89 296
Дмитрий Павловский Спасибо!
Может бывают случаи, когда и такие очевидные комментарии помогают? например, если подряд идет 20 однотипных строк, которые отличаются диапозоном переменной, ну и действием, в зависимости от диапозона?
У меня внутреннее стремление наоборот минимизировать комменты, но ведь надо ориентироваться на то, что другие или я в будущем буду читать этот код. Вот и хочу определиться, к чему стоит стремиться.
Спасибо!!!
Валентин Жерихов "Тем, что абстрактный класс является предком в цепочке наследования. " - что? Я не могу написать абстрактный класс, ни от кого не отнаследованный?
если прога предназначена для однокурсника-балбеса, то да
Твой комментарий объясняет буквальные действия, производимые согласно коду.
Это может быть полезно для человека, который не знает языка.

Для человека, умеющего программировать, гораздо полезнее будут комментарии, объясняющие замысел программиста. Работу отдельных инструкций он понимает без труда, но составление цельной картины по плохо написанному коду может быть затруднительно (особенно если код очень сложный).

Почему код «плохо написанный»? Здесь я ссылаюсь на Роберта Мартина, автора книги «Чистый код». Он уверен: хорошо организованный код читается и понимается сходу, как рассказ или газетная статья. Его не нужно расшифровывать. В своей книге он объясняет, как писать такой код.
Дмитрий Павловский Спасибо!
Я правильно поняла - моя строка кода плохо написана и неочевидна?
Может подскажете, как эту сточку сделать очевидной?