Frage

  • Haben Sie wechseln Kommentare oder Platten von Code, um schnell Inhalt anzeigen oder ausblenden?
  • Was sind einige Methoden, die Sie verwenden?
  • Gibt es einen akzeptierten Standard?
  • Sollten einige Methoden vermieden? dh sie könnten von einigen Motoren falsch interpretiert werden?
  • Gibt es eine Alternative oder eine bessere Lösung für dieses?

Standard - Das ist, was ich verwenden die meisten Sprachen abdecken: CSS, JavaScript, PHP, Actionscript

/**/ visible /**/
/**\/ hidden /**/

HTML

<!----> visible <!---->
<!----/> hidden <!---->

PHP - Definition von so etwas wie $ verstecken funktioniert gut, andere Variablen Produktion oder Entwickler sein könnte -. Große Platten können dann versteckt und zusammen mit einer einfachen Größenänderung angezeigt

if(0){ hidden }
if(1){ visible }
if(!$HIDE){ content } // $HIDE defined elsewhere, visible if undefined
War es hilfreich?

Lösung

Ich glaube, dass, wenn Sie programmatisch steuern können, was gemacht wird, das am besten ist (wie das, was Sie in der PHP-tat). Eine noch bessere Lösung, was Sie (im Wesentlichen eine lokale Präprozessormakro) geschrieben ist, um tatsächlich Ihre Rendering-Code in Funktionen zu brechen, die Unterteile der Dokumente erzeugen. Wenn Sie es nicht brauchen, rufen Sie es nicht, und Sie haben eine klare Bedingung im Code. Dies wird zum Beispiel der Art und Weise MediaWiki geschrieben. Ansonsten in komplexen Projekten wird es ein Chaos.

Es gibt viele Risiken zu hart Codierung den Kommentar-out im Code. Unter ihnen:

  • Sehr einfach, die Auskommentierung mess up

  • nicht klar, was kommentiert wurde.

  • Problem, wenn auf Kommentar Abschnitte überlappen

  • Ausschneiden und Einfügen von Fehlern

  • Alles, was Sie noch zugänglich ist, wirkt Suchmaschinen verstecken wollte, etc.

Andere Tipps

/*
Commented
// */

//*
Not commented
// */

Ich habe von einigen Leuten gesagt worden, dass der richtige Weg, Abschnitte von C ++ Kommentar aus, da wir nicht mehr offenbar nicht den Präprozessor verwenden ist eine if Anweisung zu verwenden.

if(false)
{
    chunk of code;
}

Die Theorie ist, dass der Compiler, dass die toten Code aus dem Endprodukt optimieren, und Sie können verschachtelt werden, was /* */ Stil Kommentare nicht tun können.

Diese Theorie ist falsch, natürlich, weil Sie es nicht beliebige Bereiche verwenden können, um einen Kommentar aus Code, zum Beispiel:

class Foo
{
    void Bar();
    if(false)
    {
        int Baz(double); // WRONG!!!
    }
};

Auf der anderen Seite, das funktioniert perfekt für Sprachen wie Python, das jeder Aussage in jedem Block zu ermöglichen, und die fehlen auch einen Standard-Präprozessor oder Block Kommentare.

Ich ziehe es mit einem Texteditor, der die Struktur des Quelltextes versteht Ich bin der Bearbeitung ( Vim und Emacs die ehrwürdigen Favoriten sind), und das Vim Falten oder Emacs Klapp für mich dieses Bedürfnis erfüllt.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top