Eure besten Quellcode Kommentare...

[MaBuSE]

Zitat von baumina:

Das hier gefällt mir auch ganz gut:

Immer diese OffTopic Beiträge

[Tonic1024]

Delphi-Quellcode:

                        end;
                      end;
                    end; //for j
                  end;  
                end; // for i
              end;  
            end;  
          end; // dynamic block  
        end; // precond 
      end;  
    end; 
  end;  // the end is near ;)
end;

[himitsu]

Ich glaub da fehlen noch ein paar Kommentare?

Wenn man nicht mehr erkennt (ohne diese nutzlosen/verwirrenden Kommentare), welches End zu welchem Begin gehört, dann sollte man sich langsam mal sorgen machen.
Aber eigentlich sollte man ja anhand der Einrückung, und da die Blöcke nie zu lang sind, sofort sehen was zusammengehört. (CnPack und Co. helfen sogar dabei)

[Tonic1024]

Diese nutzlosen und verwirrenden Kommentare hab ich mir in längerem Code, zusammen mit zusammenhängenden Blöcke umschlossenen von doppelten Leerzeilen (hier grad nicht) und horizontalen Minus-Linien (also //-----) an "Inhalts-Umbrüchen", angewöhnt und meine Kollegen haben sich das teilweise abgeschaut. In anderen Programmiersprachen ist es teilweise zwingend verschiedene Ends zu unterscheiden (end if in VB).

Kann da nichts schlimmes dran finden. Alles was der Übersicht dient ist in meinen Augen erst einmal gut. Wer sich von solchen Details allen Ernstes verwirren lässt darf sie gerne entfernen falls er mit meinem Code arbeiten muss. Viel schlimmer finde ich alternatives Phantasie-Einrück-Verhalten. Da kommt mir kein Azubi mit durch. Seinen eigenen Stil darf man bei mir erst nach der Prüfung entwickeln.

[Mikkey]

Ich finde da ebenfalls nichts Schlimmes dran.

An der Uni habe ich Algol-68 gelernt (einer der Vorläufer von C) und finde es ausgesproche schade, dass die dort erfundene Art der Klammerung kein Allgemeingut geworden ist:

Code:

if ... fi
do ... od
case ... esac

Im Gegensatz zum kryptischen

Code:

x = (a==b?c:d);

[himitsu]

Das compiler-unterstützte (b ? c : d) hätte einen Vorteil, gegenüber den IfThen-Funktionen vom Delphi.

Als Funktionsparameter wird c und d erstmal komplett ausgewertet, übergeben und dann erst in der Funktion wird entschieden was man nun braucht.
Beim ?: optimiert das der Compiler gleich so, daß nur der "benutzte" Teil ausgewertet wird.




PS: Was schön ist, ist Code, der immer schön erweitert wird, aber die Codeformatierung nicht mit angepasst wird.
z.B. die Einrückung nicht verschoben, wenn noch ein if+begin+end oder try+finally/except drum gekommen ist.

Ja, wenn man beim SVN die Leerzeichen nicht ignorieren lässt, dann mg das da zwar besser aussehen, aber der Code ist nach mehreren Änderungen absolut nicht mehr lesbar, egal wieviele Kommentare man da noch rein macht.

[BUG]

Zitat von Mikkey:

Code:

if ... fi
do ... od
case ... esac

Das finde ich wiederum gruselig (warum auch immer). In Bash-Scripte wird diese Notation genutzt.

Zitat von Mikkey:

Im Gegensatz zum kryptischen [...]

Man darf aber nicht vergessen, das C auch ein normales if hat

[Mikkey]

Ja stimmt, in Shellskripten gips das auch.

Das normale if kann man aber nur in alternativen Anweisungen verwenden, nicht in alternativen Daten.

Bei Algol68 ging nicht nur

Code:

x := (a=b|c|d);

sondern auch

Code:

(a=b|DoSomething()|DoSomethingElse());

[r2c2]

Zitat von Tonic1024:

Diese nutzlosen und verwirrenden Kommentare hab ich mir in längerem Code, zusammen mit zusammenhängenden Blöcke umschlossenen von doppelten Leerzeilen (hier grad nicht) und horizontalen Minus-Linien (also //-----) an "Inhalts-Umbrüchen", angewöhnt und meine Kollegen haben sich das teilweise abgeschaut.

Das ist ein Zeichen dafür, dass deine Methoden zu lang sind. "Inhaltliche Trennungen" macht man am besten durch syntaktische Trennungen. Neue Methoden, neue Klassen, etc. Und damit sind die Ganze Kommentiererei auch schon überflüssig. Darf ich ein Buch empfehlen? Clean Code.

[Headbucket]

Wenn mehrere Leute am selben Code arbeiten:

//FreeAndNil(td^.tr[2]); //2 Kanal brauchen wir nicht //brauchen wir doch //To-Do

Gruß
Headbucket