Delphi-PRAXiS
Seite 1 von 3  1 23      

Delphi-PRAXiS (https://www.delphipraxis.net/forum.php)
-   Softwaretests und Qualitätssicherung (https://www.delphipraxis.net/86-softwaretests-und-qualitaetssicherung/)
-   -   Diskussion: Unbenötigten Code löschen? (https://www.delphipraxis.net/160304-diskussion-unbenoetigten-code-loeschen.html)

nachti1505 6. Mai 2011 13:25

Diskussion: Unbenötigten Code löschen?
 
Bekannte Autoren (Fowler et.al.) empfehlen ja, ungenutzten oder gar auskommentierten Code aus der working-copy ins Nirvana zu schicken, mit der Begründung in der Quellcodeverwaltung sei ja alles noch vorhanden. Bis zu diesem Punkt korrekt!

Nun habe ich in unserem Unternehmen - spezieller in unserer Anwendung - viele Dutzend Stellen dieser Art entdeckt und mir überlegt, diese gemäß dem Clean-Code-Ansatz zu eleminieren. Sie sind ja tatsächlich im SVN noch vorhanden. Ich frage mich allerdings jetzt, wie beispielsweise jemand anderes in drei Jahren Funktionalitäten wiederentdecken möchte, die heute auskommentiert und morgen nur noch im SVN vorhanden sind?

Für einen Entwickler stellen sich ja naturgemäß später die Fragen:

1) Gab es da mal was?
2) Wo gab es das?

Wie kann man vorgehen, um den zukünftigen Entwicklern hier eine Brücke zu bauen und eventuell verschwundene Code-Schnipsel wieder entdecken?

alfold 6. Mai 2011 13:31

AW: Diskussion: Unbenötigten Code löschen?
 
Evtl and der Stelle eine Kommentarzeile einfügen, wo sich das original befindet?
So kann man auch später noch mal schauen, aha so sah dies mal aus, warum wurde er geändert usw

Ansonsten Dokumentation.

Gruss alfold

s.h.a.r.k 6. Mai 2011 13:45

AW: Diskussion: Unbenötigten Code löschen?
 
Mögliche Erwähnungen können im Commit-Kommentar, Changelog oder Ticketsystem positioniert werden. Mehr fällt mir spontan nicht ein :)

himitsu 6. Mai 2011 13:49

AW: Diskussion: Unbenötigten Code löschen?
 
Wenn die delphiinterne Dateisuche jetzt auch noch in den alten Repositories suchen würde, dann könnte man dort sowas auch wiederfinden.

Coffeecoder 6. Mai 2011 14:01

AW: Diskussion: Unbenötigten Code löschen?
 
Hallo,

Danke dass du dieses Thema ansprichst. Ich gebe mal meine Meinung dazu ab:

Zitat:

Mögliche Erwähnungen können im Commit-Kommentar, Changelog oder Ticketsystem positioniert werden. Mehr fällt mir spontan nicht ein
Einer der besten Idee. Quasi ein Bericht erstellen, auch von alten gelöschten Funktionen.
Toter Code, also nicht mehr gebrauchbarer Code sollte nicht im Quelltext stehen.

Mfg Coffeecoder

s.h.a.r.k 6. Mai 2011 14:14

AW: Diskussion: Unbenötigten Code löschen?
 
Naja, der Punkt ist ja, dass der Code ja mal in das System gewandert ist, ergo ist das schon mal dokumentiert worden und somit auch im SVN vorhanden. Wenn der dann wieder rausgeworfen wird, dann wird das ja auch dokumentiert, ebenso der Grund. Sollte mal jemand was nachschauen wollen, dass muss er halt entsprechend suchen, daher sollte die Doku gut ist ;)

himitsu 6. Mai 2011 14:27

AW: Diskussion: Unbenötigten Code löschen?
 
Für die Zeit der Umstellung / für eine Weile kann man ja den alten Code noch drin lassen und als Delphi-Referenz durchsuchendeprecated markieren, mit einem Hinweis auf den neuen Ort.

s.h.a.r.k 6. Mai 2011 14:36

AW: Diskussion: Unbenötigten Code löschen?
 
Vielleicht sollte man noch dazu sagen, dass man hier eine Art Regelwerk zusammenstellen sollte, wie man was zu machen hat. Wenn das jeder verinnerlicht, dann sollte die Suche später auch nicht schwer fallen.

blauweiss 6. Mai 2011 15:15

AW: Diskussion: Unbenötigten Code löschen?
 
Manchmal ist für mich toter (auskommentierter Code) noch nützlich, um zu dokumentieren, A) welcher alternative Ansatz schon mal versucht wurde und B) warum er nicht funktionierte.
Bin mir nicht sicher, ob es immer so einfach ist dafür einen guten Change-Text zu schreiben. Also so gut, daß der alte Code in der SVN verschwinden kann.

Wobei ich gestehen muß, daß bei mir B) / A) ~ 20% :oops:

Grüße,
blauweiss

Namenloser 6. Mai 2011 17:55

AW: Diskussion: Unbenötigten Code löschen?
 
Also ich als Hobbyprogrammierer kommentiere alten Code meist erst mal nur aus, wenn ich eine alternative Lösung schreibe. Erst wenn ich dann nach einiger Zeit sicher bin, dass die neue Lösung stabil läuft, lösche ich den toten Code dann komplett.

@blauweiss Ja, mache ich auch so ähnlich.


Alle Zeitangaben in WEZ +1. Es ist jetzt 13:46 Uhr.
Seite 1 von 3  1 23      

Powered by vBulletin® Copyright ©2000 - 2024, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024 by Thomas Breitkreuz