nicht angemeldet
Halihallo romy
Bei der Forumsuche nach diesem Thema habe ich irgendiwe keinen geeigneten Suchbegriff gefunden -> wenn es also schon einen Thread dazu gab, vielleicht weiss ja noch jemand wo der steht.
Ne, leider nein.
- 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. Z. B. lan_wort, sys_remote_user, usr_name . Aber dass du soviele Variablen
hast, lässt mich darauf schliessen, dass du riesige Programme in einer Datei hast; dann
kommt man notgedrungen in Probleme, eine sinnvolle Namensgebung zu erstellen. Meiner
Meinung nach ist es besser, wenn die Programme per se aufgesplittet werden und so in
eine Art "Namensraum" (u. B. eben Sprachmodul, Systemmodul, Datenstoragemodul
etc.) "gepresst" werden. In diesen Namensräumen oder besser Anwendungsbereichen sind
auch einfache, kurze Namen für Variablen eindeutig zu verstehen (zumindest besser).
- Deutsch oder Englisch oder gemischt?
Wie es dir beliebt, aber im Sinne von anderen: Entscheide dich für eine Sprache.
- würdet ihr diese Variablen nochmals irgendwo auflisten um sie zu erläutern
Höchstens die wichtigsten und am besten dort, wo sie definiert sind: im Quelltext. Das
erleichtert anderen Programmierern, das lesen des Quelltextes (nicht bei jeder Variablen
in einer anderen Dokumentation nachsehen).
---
Allgemein: Die Funktionsweise/Zweck der Variablen lässt sich auch aus dem Kontext lesen.
Wenn der Kontext (kleine Codeschnipsel) also gut dokumentiert bzw. selbsterklärend ist,
ist auch die Variable von Sinn her "wiederherstellbar". Falls der Kontext nicht für sich
spricht bzw. nicht auf Anhieb erkenntlich ist, braucht es einen Hinweis für den Leser.
Eine ausgewogene in-file (durch Kommentare oder meinetwegen POD) Dokumentation kleiner
Codepassagen und Variablen fördert das Lesen des Quelltextes enorm und du wirst keine
Probleme damit haben, dein Code auch in 6 Mt. noch zu verstehen.
Viele Grüsse und HTH
Philipp