Это плохая практика оставлять закомментированный код в производственных выпусках

Question

Я регулярно вижу производственный код от разработчиков (крупных компаний и частных лиц), который содержит закомментированный код.Предположительно это устраняет более ранние попытки достижения функциональности, которая по какой-то причине не работала.

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

Есть ли какие-либо аспекты безопасности или передовой опыт?

Answer 1

Лучше всего использовать SCM.Если вы думаете, что старый код действительно является тем, на что люди захотят ссылаться в будущем, оставьте комментарий «// Мы привыкли делать это другим способом, у которого было интересное свойство X - см. Ревизию 103» вместо того, чтобы оставлять целые кускикода, который ничего не делает.

Комментирование кода имеет свое место, но это место - быстрые тесты, которые даже не стоят времени на создание ветки.

Если код стоит сохранить, он стоит больше, чем быть потерянным где-то в комментарии.Если его не стоит хранить, убейте его огнем.

Answer 2

Код должен храниться в системе контроля версий.Комментарии должны быть зарезервированы, чтобы объяснить трудный для понимания код или причину сделать что-то необычное.

Answer 3

Рекомендуется, чтобы ваш код отображал только текущий код.Вы должны использовать SCM, который имеет дело с историей кода.