richtig kommentieren

  1. balufreak

    balufreak Thread StarterMacUser Mitglied

    Mitglied seit:
    12.10.2003
    Beiträge:
    1.556
    Zustimmungen:
    28
    guten morgen allerseits

    ich habe mir da mal eine frage gestellt. und zwar habe ich schon mehere php seiten gemacht. aber der code ist zum teil recht unübersichtlich. im internet habe ich mal gesucht, wie man php dateien eigentlich kommentiert/dokumentiert. so mit header und so. hab aber nichts schlaues gefunden, bzw. bin nicht auf einen standard gestossen. nun wollte ich mal fragen, wie dokumentiert/kommentiert ihr eure php dateien so? was schreibt ihr in die header, wie kommentiert man klassen, dass sie z.B von Zend Studio oder Eclipse erkennt werden usw.

    Greets balu
     
    balufreak, 28.08.2006
  2. koli.bri

    koli.bri

    Also ich kommetiere fast alles damit, was es macht.

    Am Anfang der Datei kommt der Dateiname, und der Zweck der Datei, eventuell was sie darf und was nicht.
    Funktionen bekommen die Parameter als Kommentar.
    Im Grunde so, dass, wenn ich den eigentlichen Code weglasse, dass ich imer noch genau weiß, was die Datei macht

    Wegen Eclipse und Zend-Konformer Kommentation:
    Ich würd mal gucken, die die beiden das von Haus aus machen, und mir das quasi abschauen...
     
    koli.bri, 28.08.2006
  3. wegus

    wegusMacUser Mitglied

    Mitglied seit:
    13.09.2004
    Beiträge:
    14.982
    Zustimmungen:
    1.545
    Gib Deine Klasse kommentarlos jemand Anderem! Wenn er damit arbeiten kann war der Kommentar gut :)

    Jede Datei muß einen header haben ( Name, Beschreibung, Author, Besonderheiten, History). Jede Methode muss eine Kurzbeschreibung besitzen, ebenfalls ein Datum und eine History. Parameter und Return.Werte müssen beschrieben sein.

    Gute Dokumentation ist maschinell extrahierbar!
     
    wegus, 28.08.2006
  4. balufreak

    balufreak Thread StarterMacUser Mitglied

    Mitglied seit:
    12.10.2003
    Beiträge:
    1.556
    Zustimmungen:
    28
    balufreak, 28.08.2006
Die Seite wird geladen...
Ähnliche Themen - richtig kommentieren
  1. macu13
    Antworten:
    20
    Aufrufe:
    4.627
    Mankind75
    28.12.2013
  2. GoPeter
    Antworten:
    4
    Aufrufe:
    816
  3. max@hismac
    Antworten:
    1
    Aufrufe:
    969
    max@hismac
    02.10.2011
  4. StephanSch
    Antworten:
    4
    Aufrufe:
    1.088