Tom2: Variablennamen - Eindeutigkeit/Aussagekraft

Beitrag lesen

Hi

Ich kann Philipps aussagen nur bestätigen. Ich möchte dir trotzdem noch ein paar weitere Tipps geben, die mir sehr gehofen haben.

  1. Wie würdet ihr die Variablen benennen, vorallendingen im Hinblick auf unterschiedliche Verwendungszwecke wie zB. Sprachvariablen, Systemvariablen, allgemeine Variablen usw.
    Wenn es nötig ist, dann mache ich das mit Prefixen, welche auf den Anwendungszweck hindeuten. [...]

Zusätzlich habe ich mir noch angewöhnt, einen Prefix für den Datentyp zu setzen. Wenn du Varianten (also Variablen, die mehrere Datentypen speichern können) verwendest, so ist dies sehr hilfreich.
Auch der Stil trägt IMHO sehr viel zum Verstehen bei: z.B. schreibe ich Konstanten gross und verwende in normalen Variablennamen Gross-/Kleinschreibung um die Lesbarkeit zu verbessern. Funktionsnamen   beginnen bei mir meist mit einem Verb.

  1. Deutsch oder Englisch oder gemischt?
    Wie es dir beliebt, aber im Sinne von anderen: Entscheide dich für eine Sprache.

Also ich entscheide mich (zumindest bei Kommentaren) für die Muttersprache. Dadurch kann ich ganz klar niederschreiben, was ich mir beim Coden überlegt habe.

  1. würdet ihr diese Variablen nochmals irgendwo auflisten um sie zu erläutern

Ich schreibe jeweils hinter der Definition einer Variablen einen kurzen Kommentar.

Du merkst also: Kommentare, Kommentare, Kommentare. Teile dein Programm gedanklich in Schritte auf und kommentiere diese. Wie gross du diese Schritte wählst musst du selbst herausfinden. Wichtige Passagen, an denen du lange gearbeitet hast oder bei der dir viele Fehler unterlaufen sind, solltest du sehr ausführlich dokumentieren. Und eigne dir einen gewissen Programmierstil an und behalte diesen bei. Dadurch wird das Lesen eines Programms auch stark vereinfacht.

MfG

Tom2

PS: Hey, dies ist ja mein erstes Posting im Jahre 2003! Somit wünsche ich allen noch nachträglich ein gutes Neues!

--
"Experience is something you don't get until just after you need it."
 by Steven Wright