Wie kommentiert ihr?

Blue-Tiger

byto schrieb:

tntnet schrieb:

Kommentare sollten nicht das enthalten, was das Programm tut. Das sieht man im Code.

Ich möchte mir aber nicht jedes Mal erst den Code angucken, um zu wissen, was eine Methode tut, wenn ich sie an einer beliebigen Stelle aufrufe.

Deshalb gibts sprechende Funktionsnamen

Schreibt ihr als noch den Aufwand in eure Dokumentation? Und wie stets mit dem Speicherverbrauch? Also ich meine hier keine konkreten Werte, sondern ein O(1), oder vllt. mit etwas mehr Information O(3n).

Wenns relevant ist ist schon, ja. Aber dass mein log2(x)-Hilfsfunktion in O(log n) statt in O(n) (mit n Anzahl Bits von x) arbeitet, interessiert z. B. niemand ( es sei denn ich schreibe eine Mathe-Library).
Aber dass mein findSimilarFiles(File f, Directory d) im "FindeDoppelteMP3s"-Programm in O(n*n) der Files im gegebenen Verzeichnis arbeitet, ist erwaehnenswert. Aber mehr als die Komplexitaetsklasse gibts da auch nicht.

loks schrieb:

Kommentierung im Stil:
...
} // end main-function
etc sind einfach nur Schwachsinn und sogar Kontroproduktiv

kommt drauf an, wie länglich deine 'main-function' ist.

asc

-fricky- schrieb:

kommt drauf an, wie länglich deine 'main-function' ist.

Zu große Funktionen deuten immer auf einen schlechten Stil hin. Funktionen sollten nur so groß sein das man sie noch sinnvoll überblicken und verstehen kann. Daher sehe ich diese Form der Kommentierung eh als Schwachsinn an.

cu André

Shade Of Mine

-fricky- schrieb:

loks schrieb:
Kommentierung im Stil:
...
} // end main-function
etc sind einfach nur Schwachsinn und sogar Kontroproduktiv
kommt drauf an, wie länglich deine 'main-function' ist.

nein. denn dafür hast du eine ide

mal abgesehen davon dass wenn eine funktion ueber mehr als eine seite geht, du andere probleme hast als kommentare...

asc schrieb:

Zu große Funktionen deuten immer auf einen schlechten Stil hin. Funktionen sollten nur so groß sein das man sie noch sinnvoll überblicken und verstehen kann. Daher sehe ich diese Form der Kommentierung eh als Schwachsinn an.

schon richtig, aber manchmal gibts switch/case-anweisungen die ganz schön lang sein können. da ist so'n kommentar */* end of switch(...) / gar nicht so verkehrt.

Knuddlbaer

mal abgesehen davon dass wenn eine funktion ueber mehr als eine seite geht, du andere probleme hast als kommentare...

z.B. die Realität wie Praxis oder Wirtschaftlichkeit - manchmal auch einfach switch Statements.

byto

-fricky- schrieb:

asc schrieb:

Zu große Funktionen deuten immer auf einen schlechten Stil hin. Funktionen sollten nur so groß sein das man sie noch sinnvoll überblicken und verstehen kann. Daher sehe ich diese Form der Kommentierung eh als Schwachsinn an.

schon richtig, aber manchmal gibts switch/case-anweisungen die ganz schön lang sein können. da ist so'n kommentar */* end of switch(...) / gar nicht so verkehrt.

Wo wir wieder beim schlechten Stil wären...

byto schrieb:

Wo wir wieder beim schlechten Stil wären...

was tust du denn z.b. gegen einem switch mit 30 cases?

by the hammer

SideWinder

Gibt verschiedene Möglichkeiten, zB:

methods[case].invoke();

MfG SideWinder

SideWinder schrieb:

Gibt verschiedene Möglichkeiten, zB:
methods[case].invoke();

das fängt nicht den default-fall ab. ausserdem erzeugen compiler für sitch/case-konstrukte sehr effizienten code, was bei einer tabelle mit function-pointern nicht immer gegeben ist. also ich finde es nie gut, performance gegen 'schönen code' zu tauschen.

mit C++-style kommentaren statt C-style kommentaren

byto

-fricky- schrieb:

byto schrieb:

Wo wir wieder beim schlechten Stil wären...

was tust du denn z.b. gegen einem switch mit 30 cases?

Polymorphie nutzen.

Bashar

byto schrieb:

Polymorphie nutzen.

Gratulation, du hast gerade eine Funktion zu 30 vom Designstandpunkt her völlig überflüssigen Klassen vereinfacht.

SideWinder

-fricky- schrieb:

SideWinder schrieb:

Gibt verschiedene Möglichkeiten, zB:
methods[case].invoke();

das fängt nicht den default-fall ab. ausserdem erzeugen compiler für sitch/case-konstrukte sehr effizienten code, was bei einer tabelle mit function-pointern nicht immer gegeben ist. also ich finde es nie gut, performance gegen 'schönen code' zu tauschen.

Ich würde immer Performance gegen "schönen Code" tauschen. Aber abgesehen davon, habe ich nicht behauptet, dass mein Code "schön" ist. Es war nur ein Beispiel. Das kommt dann immer auf das konkrete Beispiel an. Aber Dinge wie:

switch(errorcode)
{
    case 404: return NLS.get("DOC_NOT_FOUND"); break;
    ... // weitere 1000 fälle
}

rgen mich ganz furchtbar auf:

String str = NLS.get(errorMap.get(404));

MfG SideWinder

SideWinder

Wobei, wenn man tatsächlich mehr als 5 "Modi" hat die alle differenten Quellcode zur Ausführung bringen und die wirklich (meistens Designschwäche) durch das selbe switch abgedeckt werden sollen, würde ich schon auf dynamischen Methodenaufruf setzen (da brauch ich dann auch keinen default-Fall, denn default-mäßig ruft mein Benutzer nicht den Punkt File->Open auf ... im Notfall kommt eine NotFoundException und auf die kann ich dann reagieren).

MfG SideWinder

byto schrieb:

Polymorphie nutzen.

ich wusste doch, dass es noch sinnvolle anwendungen von OOP gibt.

SideWinder schrieb:

Wobei, wenn man tatsächlich mehr als 5 "Modi" hat die alle differenten Quellcode zur Ausführung bringen und die wirklich (meistens Designschwäche) durch das selbe switch abgedeckt werden sollen, würde ich schon auf dynamischen Methodenaufruf setzen.

die designschwächen machen aber oft andere (siehe dein beispiel mit dem http) und damit muss man leider leben.

SideWinder schrieb:

im Notfall kommt eine NotFoundException und auf die kann ich dann reagieren).

das halte ich wiederum für schlechten stil: exceptions einzusetzen, obwohl man mit einem einfachen 'if' testen kann, ob ein wert überhaupt gültig ist.

tfa

Bashar schrieb:

byto schrieb:

Polymorphie nutzen.

Gratulation, du hast gerade eine Funktion zu 30 vom Designstandpunkt her völlig überflüssigen Klassen vereinfacht.

Woher willst du das wissen? Vielleicht hat er auch unwartbaren Spaghetticode zu einem vernünftigen OO-Design gemacht.

SideWinder

@fricky: Naja, grundsätzlich kann der Benutzer keine nicht vorhandenen Menüpunkte aufrufen. Also handelt es sich in so einem Fall imho sehrwohl um eine Exception.

Edit: Ja, damit muss man wohl leben. Aber man muss diese Schwächen (warum auch immer die hier sind - gibt es eine bessere Methode?) nicht auch noch mit schwachem Code in das eigene Projekt hineinziehen.

MfG SideWinder

SideWinder schrieb:

@fricky: Naja, grundsätzlich kann der Benutzer keine nicht vorhandenen Menüpunkte aufrufen. Also handelt es sich in so einem Fall imho sehrwohl um eine Exception.

nichtvorhandene menüpunkte triggern keine aktionen, also können auch keine exceptions auftreten. aber ich glaube, so langesam reden wir aneinander vorbei.