Wenn ein "Beispiel" mehr als tausend Worte sein können, kann ein Programmierer für ein "Kommentar" im Wert von Stunden und Stunden der Arbeit! Kommentieren Sie den Code ist oft langwierig und zu der Zeit den Code zu schreiben, es scheint immer ein vergeblicher. Im Gegenteil, vor allem wenn man alten Code, der Kommentar bringen Sie in die richtige sein kann unendlich nützlich zu rekonstruieren geistige Pfade in Vergessenheit geraten sind. Zum Glück für jene wie mich, die Web entwickelt haben, können Sie auf der riesigen vatanggio fast den gesamten Code in der gleichen Weise Kommentar! Der Doppel-Schrägstrich (/ /) oder Eindämmung durch Schrägstrich Stern und der Schrägstrich Sternchen (/ * und * /) wird von praktisch allen lunguaggi Entwicklung gemeinsamer Nutzung, praktisch alle aus dem C abgeleitet unterstützt: JavaScript, ActionScript, PHP, ...
Wie Überschriften, zum Beispiel verwende ich immer eine Struktur dieser Art, das Gleiche für fast alle Sprachen, die ich verwenden:
1 2 3 4 5 6 7 8 9 | / * ** @ Name: main.as ** @ Beschreibung: die Hauptklasse der Flash-Projekt ** @ Author: undo = = ** @ Web: http://www.undolog.com ** @ Email: @ g.fazioli undolog.com - g (dot) Fazioli (at) undolog (dot) com ** ** @ Ver: 1.0 * / |
genau die gleiche Syntax kann auch für Javascript oder PHP verwendet werden. Verwenden Sie das @-Symbol (at), die Schnecke, um so die Kommentare in den Code schnell, ultile für Kommentare zu Funktionen (Methoden), Ereignisse und Eigenschaften track:
1 2 3 4 5 6 7 8 | / * ** @ Name: collapse () ** @ Beschreibung: erzeugt einen parse-Typ ** @ Parameter: Wert - Wert des Zusammenbruchs **: Type - Art des Zusammenbruchs ** @ Ergebnis: true, wenn ok, false, wenn Fehler ** @ Seealso: uncollapse () * / |
In Actionscript, wo es öfter mit Klassen, Methoden, zwischen (öffentlich oder privat) zu unterscheiden tun, können Ereignisse und Eigenschaften praktisch durente werden die Verabschiedung eines Code:
1 2 3 4 5 | / * ** @ Name: ontopdown () ** @ Beschreibung: (event) - trigged, wenn das Element aktiv ist ** @ Seealso: ontopup () * / |
1 2 3 4 5 | / * ** @ Name: Farbe ** @ Beschreibung: (property) - get / set die Hintergrundfarbe ** @ Seealso: bgcolor * / |
Es stimmt, würde ich sagen, dass nicht nur helfen, sich wieder den Code zu lesen, wird auch denen helfen, die nach Ihnen kommen (wenn Sie auf gemeinsamen Projekten zu arbeiten). In diesem Fall wird es auch eine Form von Respekt, lassen Sie einen guten Job in den Händen anderer macht das Leben leichter für andere.
Irgendwo las ich ein Zitat von jemanden, der Englisch sprach, "als ob das Programm ist, dass, nachdem Sie ein Psychopath, wo Sie leben weiß waren"
@ Chris: heilige Worte!