¿Existe un estándar para mostrar y ocultar contenido fácilmente?

Question

• ¿Alterna los comentarios o las losas de código para mostrar u ocultar rápidamente el contenido?
• ¿Cuáles son algunos métodos comunes que usa?
• ¿Hay un estándar aceptado?
• ¿Deben evitarse algunos métodos? es decir, ¿podrían ser malinterpretados por algunos motores?
• ¿Existe una solución alternativa o mejor a esto?

Estándar : esto es lo que uso para cubrir la mayoría de los idiomas: CSS, JavaScript, PHP, ActionScript

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

HTML

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

PHP : la definición de algo como $ hide funciona bien, otras variables podrían ser de producción o de desarrollo: las losas grandes pueden ocultarse y mostrarse juntas con un simple cambio de variable.

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

Answer 1

Creo que si puedes controlar programáticamente lo que se está renderizando, eso es lo mejor (como lo que hiciste en el PHP). Una solución aún mejor que lo que escribió (esencialmente una macro de preprocesador local) es realmente dividir su código de representación en funciones que generan sub partes de los documentos. Si no lo necesita, no lo llame y tiene una condición clara en el código. Esta es, por ejemplo, la forma en que se escribe MediaWiki. De lo contrario, en proyectos complejos, se convierte en un desastre.

La codificación de los comentarios en el código conlleva muchos riesgos. Entre ellos:

• Muy fácil de desordenar lo que no comenta

• No está claro lo que se comentó.

• Problema cuando las secciones comentadas se superponen

• Corta y pega errores

• Todo lo que quisiste ocultar sigue siendo accesible, afecta a los motores de búsqueda, etc.

Answer 2

/*
Commented
// */

//*
Not commented
// */

Answer 3

Algunas personas me han dicho que la forma correcta de comentar las secciones de C ++, ya que al parecer ya no usamos el preprocesador, es usar una declaración si .

if(false)
{
    chunk of code;
}

La teoría es que el compilador optimizará ese código muerto del producto final, y se pueden anidar, lo que no pueden hacer los comentarios de estilo de / * * / .

Esa teoría es falsa, por supuesto, porque no puedes usarla para comentar regiones arbitrarias de código, por ejemplo:

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

Por otro lado, esto funciona perfectamente para lenguajes como python que permiten cualquier declaración en cualquier bloque, y que también carecen de un preprocesador estándar o comentarios de bloque.

Answer 4

Prefiero utilizar un editor de texto que entienda la estructura del texto de origen que estoy editando ( Vim y Emacs son los favoritos venerables), y que puede hacer el plegado de código en función de la estructura analizada por el editor.

Cualquiera de plegado Vim o el plegado de Emacs satisface esta necesidad para mí.