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

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

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

Существуют ли какие-либо аспекты безопасности или наилучшей практики?

3 9
coding-style comments

3 ответа:

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

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

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

26

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

1

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

0