Ist es eine schlechte Übung, auskommentierten Code in Produktionsversionen zu hinterlassen?

7

Ich sehe regelmäßig Produktionscode von Entwicklern (große Unternehmen und Einzelpersonen), der Code enthält, der auskommentiert wurde. Vermutlich beseitigt dies frühere Versuche, die Funktionalität zu erreichen, die aus irgendeinem Grund nicht funktionierte.

In meinen Augen ist das unordentlich, hat aber möglicherweise einige Vorteile, z. Bei der Rückkehr zum Refactor oder zur Erweiterung des Codes kann der Entwickler sehen, was zuvor versucht wurde.

Gibt es irgendwelche Sicherheits- oder Best-Practice-Aspekte?

    
Jonathan Day 08.09.2010, 02:42
quelle

3 Antworten

23

Es empfiehlt sich, SCM zu verwenden. Wenn Sie der Meinung sind, dass der alte Code wirklich etwas ist, auf das sich die Leute in Zukunft beziehen wollen, hinterlassen Sie einen Kommentar von "// Wir haben es anders gemacht, mit der interessanten Eigenschaft X - siehe Revision 103" anstatt ganze Teile zu hinterlassen von Code, die nichts tun.

Kommentieren Code hat seinen Platz, aber dieser Ort ist Quickie-Tests, die nicht einmal die Zeit wert sind, eine Verzweigung zu machen.

Wenn es sich lohnt, den Code beizubehalten, ist es mehr wert, als irgendwo in einem Kommentar verloren zu gehen. Wenn es sich nicht lohnt zu halten, töte es mit Feuer.

    
Chuck 08.09.2010, 02:51
quelle
1

Code sollte in der Quellcodeverwaltung gespeichert werden.
Kommentare sollten reserviert werden, um schwer verständlichen Code oder den Grund für etwas Außergewöhnliches zu erklären.

    
sHr0oMaN 08.09.2010 03:25
quelle
0

Bewährte Methode ist, dass Ihr Code nur die aktuelle zeigt. Sie sollten einen SCM verwenden, der sich mit dem Codeverlauf befasst.

    
Zaz 08.09.2010 03:09
quelle

Tags und Links