PHP-Änderungen klar kommentieren

Gibt man bei Google „Fußzeile WordPress“ ein, so erhält man eine Menge Tipps wie man durch ändern von \wordpress\wp-content\themes\twentyten\footer.php die Ausgabe der Fußzeile verändern kann. Doch wenn man schon nicht Änderungen an den PHP-Skripts von WordPress vermeiden kann, so sollte man sich doch im eigenen Intresse an verschiedene Regeln halten. Das Stichwort heißt „Quelltext-Kommentare“.  Für einen pragmatischen Programmierer versteht es sich von selbst, Quelltexte ordentlich zu kommentieren. Diese Kommentare haben auch bei WordPress den Vorteil, dass ein Teil der Dokumentation zum Beispiel über phpDocumentor generiert werden kann. Details zur „Inline Documentation“ kann im WordPress-Codex nachgelesen werden. Meine Skript-Änderungen versehe ich immer mit meinem Kürzel @JM und dem Datum wie Sie an dem folgenden Code-Schnipsel sehen können:

<div id="masthead">
    <div id="branding" role="banner">
        <?php $heading_tag = ( is_home() || is_front_page() ) 
        <?php
            //@JM 08.04.2011 Beim Standard wird hier der Name 
            // Check if this is a post or page, if it has a 
            if ( is_singular() && current_theme_supports
        has_post_thumbnail$post->ID ) &&
                ( /* $src, $width, $height */ $image wp_get

Über z.B. Windows Grep erhält man dann schnell einen Überblick über alle Änderungen, die man selbst an den Skripts vorgenommen hat.