Ergebnis 1 bis 5 von 5

Thema: Was muss dokumentiert werden?

  1. #1
    Teeny
    Registriert seit
    26.05.2012
    Beiträge
    22
    Danke
    0
    Bekam 0 mal "Danke" in 0 Postings

    Standard Was muss dokumentiert werden?

    Hallo Zusammen.

    Frage an die Profis von Euch: Während ihr eine Website erstellt bzw. verschiedene PHP-Scripte / -Seiten schreibt, dokumentiert ihr etwas? Ich meine, schreibt ihr euch alle Session-Variablen, Variablen, usw. auf? ... was welche Funktion oder Variable an welcher Stelle macht usw.? Was dokumentiert ihr? Ich meine nicht in das Script selbst, sondern auf Papier oder im Texteditor.

    Ich programmiere seit einigen Monaten an einer sehr großen Website und darin gibt es natürlich viele Variablen und Session-Variablen. Ich möchte nicht in die Verlegenheit kommen dass ich mal an verschiedenen Stellen zwei Mal die gleiche Variable verwende, die sich irgendwann vielleicht mal "beißen". DANN den Fehler zu finden ist ein Alptraum denke ich.

    Ich hoffe ihr wisst was ich meine und würde gerne eure Erfahrung wissen.
    Danke!

    UWE
    Achtung: Dies ist ein alter Thread im HTML und Webmaster Forum
    Diese Diskussion ist älter als 90 Tage. Die darin enthaltenen Informationen sind möglicherweise nicht mehr aktuell. Erstelle bitte zu deiner Frage ein neues Thema im Forum !!!!!
    Geändert von Ugenmeister (07.05.2013 um 18:39 Uhr)

  2. #2
    Bandit
    Gast

    Standard AW: Was muss dokumentiert werden?

    Zitat Zitat von Ugenmeister Beitrag anzeigen
    Ich meine nicht in das Script selbst, sondern auf Papier oder im Texteditor.
    Das mache ich nie! Im Quellcode Kommentare schreiben reicht mir.

  3. #3
    Großmeister(in)
    Registriert seit
    09.12.2008
    Ort
    Berlin
    Alter
    38
    Beiträge
    666
    Danke
    0
    Bekam 0 mal "Danke" in 0 Postings
    Blog-Einträge
    1

    Standard AW: Was muss dokumentiert werden?

    Session- und Variablennamen zu dokumentieren ist unnötig. Wenn da Überschneidungsgefahr besteht hast du ein schlechtes Softwaredesign bzw. eine schlechte Namensgebung für Variablen. Ein so umfangreiches Projekt, dass da Überschneidungsgefahr besteht sollte Objektorientiert umgesetzt sein, so dass sich diese Frage kaum bis gar nicht stellt. In Kombination mit aussagekräftigen Variablennamen erübrigt sie sich komplett.
    Nichts desto trotz macht bei einem umfangreichen Projekt das professionell umgesetzt wird die tatsächliche Programmierung ca. 50% aus, der Rest ist Dokumentation. Und ein großer Teil der Dokumentation sollte stattfinden bevor überhaupt eine Zeile Code geschrieben wird. Diese Dokumentationen haben aber wenig mit Variablennamen zu tun, da geht es um Struktur und Funktionalitäten der Software.
    "Programming today is a race between software engineers
    striving to build bigger and better idiot-proof programs,
    and the universe trying to build bigger and better idiots.
    So far, the universe is winning."
    Rick Cook

  4. #4
    Forum Guru Avatar von synaptic
    Registriert seit
    20.06.2007
    Ort
    Butzbach-Wiesental
    Beiträge
    10.901
    Danke
    45
    Bekam 48 mal "Danke" in 46 Postings
    Blog-Einträge
    1

    Standard AW: Was muss dokumentiert werden?

    und für den fall von ausnahmeprogrammierungen, die eigentlich auch nicht sein sollten, aber in der praxis doch mal vorkommen, sollten diese auch notiert werden. ebenso funktionen die essentiell sind.
    KEIN support via pn, email, messenger oder falsch geposteten threads
    Futter für deine Schnuffelzwerge gibts bei den Schnuffelzwergen TOP Qualität, also klicken und kaufen

  5. #5
    Samurai
    Registriert seit
    21.08.2011
    Beiträge
    233
    Danke
    0
    Bekam 0 mal "Danke" in 0 Postings

    Standard AW: Was muss dokumentiert werden?

    Also generell würde ich mal sagen ist das "interface" zu Dokumentieren Pflicht. D.h. alle Funktionen die du tatäschlich benutzt, im OOP-Bereich die öffentlichen (public) Methoden. Methoden, die nur intern benutzt werden (private) kann man auch undokumentiert lassen, wenn es sich um eine in sich geschlossene Komponente (Klasse) handelt.

Ähnliche Themen

  1. FotoDomino.de - soziales Netzwerk, muss getestet werden :-)
    Von FotoDomino im Forum Eure Homepages und Foren - Vorstellung und Bewertungen
    Antworten: 5
    Letzter Beitrag: 17.08.2010, 23:38
  2. Muss eine TextArea initialisiert werden ?
    Von OliverN26 im Forum HTML & CSS Forum
    Antworten: 2
    Letzter Beitrag: 10.04.2007, 15:17
  3. Externe Festplatte muss formatiert werden
    Von maw im Forum Computer - Internet Forum
    Antworten: 5
    Letzter Beitrag: 25.12.2006, 01:02
  4. Script für Pulldownmenü muss noch erweitert werden...
    Von hunkipunk im Forum PHP Forum - Apache - CGI - Perl - JavaScript und Co.
    Antworten: 0
    Letzter Beitrag: 29.11.2006, 10:48
  5. Was muss in dem Script entfernt bzw. hinzugefügt werden?
    Von im Forum PHP Forum - Apache - CGI - Perl - JavaScript und Co.
    Antworten: 1
    Letzter Beitrag: 06.07.2005, 09:24

Stichworte

Berechtigungen

  • Neue Themen erstellen: Nein
  • Themen beantworten: Nein
  • Anhänge hochladen: Nein
  • Beiträge bearbeiten: Nein
  •