Thema: Nicht einleuchtende Beispiele

[chr15]

Also mir reicht es, wenn ich z.B. den Funktionen und Variabeln aussagekräftige Namen gebe. Ich finde auch ohne Kommentare alles wieder und weiß auch noch nach jahren, was die Funktion
bool is_video_mode_aviable(int nummer);
macht.
Das heißt: Ich finde ordentlichen guten Code wichtiger als Komentare! (Solange es nur für mich ist)

[TeeJay]

Naja also ich hab mir mal ein recht umfangreiches Chatproggie unter WIndows mit der MFC gebastelt. Und wenn ich da heute mal wieder reinschaue, dann dauert das schon ne Weile bis ich mich da wieder komplett zurechtfinde.

Aber viel besser als gutes kommentieren ist gut Strukturierter Code. Da geht die Übersicht auch nicht verloren.


PS: Ich persöhnlich kommentiere eine Funktion lieber als ganzes, als überall nur kleine abgehackte, unverständliche Kommentare hinterzuschreiben.

[Roshl]

Also wenn die Funktionen kurz sind reicht eigentlich der Name derselben vollkommen als beschreibung. Und wenns bisschen länger wird ein kurzes kommentar am anfagn mehr aber auch nicht.
So zum Thema ordentlicher Code..Was empfindet ihr denn als ordentlich? Hier mal ein Beispiel meines Programmierstils, ist meine Vergleichsfunktion für Strings:

char strcmp(char *str1,char *str2)
{
    while(*str1==*str2)
    {
        if((*str1==0)&&(*str2==0)) return 1;
        ++str1; ++str2;
    }
    return 0;
}

Ist der für euch ordentlich oder wie definiert ihr das?

[chr15]

Also ich würde es einrücken!

[Roshl]

Es ist eingerückt! nur ist das beim posten hier verlorn gegangen, sry. vom if bis zum return wärs normalerweise ein Tab weiter drin

[Roshl]

das while selbst verständlich auch also das if dann 2mal

[chr15]

So schreibe ich meinen Code dann auch immer. Ich finde es ist übersichtlich.

Nochmal zu den Komentaren: zu viele machen den Code unübersichtlich!

[Another Stupid Coder]

Eigentlich ganz schön. Aber wenn ich jetzt etwas zum Beispiel zum Lernen für anfänger schreiben würde, würde ich die Variablen wirklich vollständig benennen. Bei dir ist das ja nicht besser möglich aber bei einer print funktion zum Beispiel "StringToPrint" oder sowas. Ich denke mir das muss sogar meine Informatik-Professorin verstehen

[Roshl]

Naja bei Anfängern isses schon hilfreich, aber eigentlich gewöhnt man sich relativ schnell an kurze knappe bezeichnungen, einfach aus faulheit dann immer den ganzen ewig langen Namen der Vari zu schreiben. bestes Beispiel eine Funktion zum Bildschirmlöschen würde ich nicht LöscheBildschirm(); nennen sondern einfach, so wie ichs hab, cls(); schreibt sich schneller und merkt sich besser. manchmal merkt sich ein mensch völlig sinnlose bezeichnungen besser als ewig lange beschriebungen als namen bsp: malloc kennt jeder, würde man aber das ding AlloziereSpeicher nennen würde man sichs schlechter merken können

[Another Stupid Coder]

Ich meinte ja nur für anfänger. Sonst schreibe ich auch str und nicht string

[TeeJay]

Also ich hab es mir abgewöhnt zu kurze Variablennamen zu nehmen.

Man muss halt mal etwas mehr tippen. Bei größeren Projekten lohnt es sich auf jeden Fall. Vor allem wenn mit diesen Variablen in mehreren Funktionen gearbeitet werden.

Für so kleine Funktionen ist es nicht nötig die lokalen Variablen da groß zu benennen, sofern man natürlich mehr als einen Buchstaben nimmt.

[Another Stupid Coder]

Als einzelnen Buchstaben würde ich nur Variablen verwenden die "Pseudo-Standard" sind wie i als Zähler, c als Char,...

[mastermesh]

http://www.gamedev.net/reference/programming/features/codedoc/

'The Art of Code Documentation', ein toller Artikel übers "richtige" Kommentieren von Code.