Frage von MatheNico, 45

Wie dokumentiere ich den code?

Kann mie einer die index.php professionell dokumentieren und erklären was da gemacht wird?

//pastebin.com/3CHP9zzf

//pastebin.com/95HpDrKL Davor bitte https: setzen!!!

Antwort
von sudorc, 32

//pastebin.com/3fpkdRpu

//pastebin.com/ATAx7kyb

bitte

Kommentar von fluffiknuffi2 ,

Die Skripte sind doch bereits kommentiert?

Kommentar von triopasi ,

Das ist eine Erklärung aber das sind definitiv keine guten Kommentare, die man so in seinen Code schreiben sollte.

Kommentar von sudorc ,

Da hast du natürlich zu 100% recht. Kommentieren sollte man stets in englisch, und auch die richtigen Kommentarcharakter für mehrzeilige Kommentare nutzen. Als Beispiel kannst du (TE) dir z.B. für PHP-Code auch mal die PSR-0-1 Konventionen anschauen.

Ich habe mich oben mehr aufs Erklären beschränkt.

@triopasi - Du hättest deine Tipps zum Kommtieren von Code ruhig hier veröffentlichen können, statt nur zu kommtieren das dass Beispiel oben unzureichend ist ;)

Kommentar von waswesich ,

...wieso alles in englisch kommentieren, was machen dann
die, die kein Englisch können? Googlen??? ;-)

Kommentar von triopasi ,

War/Bin am Handy, da is nicht mit viel schreiben, sorry. Allgemein: Das Wichtigste ist meiner Meinung nach "Nichts kommentieren was eh schon offensichtlich ist.", denn: auch zu viele Kommentare machen den Code unübersichtlich! Hier bei dem Minicode naja, das ist alles recht offensichtlich, aber ich würde wsl dazu tendieren nur einen "Beschreibungskommentar" drüber setzten anstatt das IF etc nochmal einzeln zu beschreiben. Aber bei Funktionen zB da reicht dann ein Kommentar zur gesamten Funktion zusammen mit einem Funktionsnamen der für sich spricht. Wenn die Funktion zu lang istvsollte sie eh aufgeteilt werden. Ausserdem wird nicht kommentiert WIE der Code etwas macht sondern nur WAS er macht. Sprache allgem. schon englisch, genau wie die Benennung der Variablen etc, aber wer nur für sich schreibt, was solls... man sollte sich vllt trotzdem ans Englisch gewöhnen.

Kommentar von triopasi ,

Cool, die Zeilenumbrüche wurden alle entfernt. Hoffe man kanns trotzdem erahnen wo die hin sollten.

Keine passende Antwort gefunden?

Fragen Sie die Community

Weitere Fragen mit Antworten