! - open - Perché così tanti sviluppatori fanno questo nel loro HTML? !- /vicino --

Question

! - open - Perché così tanti sviluppatori fanno questo nel loro HTML? !- /vicino --

#1 da (9 voti)
#2 da (6 voti)
#3 da (4 voti)
#4 da (2 voti)
#5 da (1 voti)
#6 da (1 voti)

8

 <body>  
  <!-- wrapper -->  
  <div id="wrapper"> 
   <!-- title -->
   <div id="title"><img src="title.png" alt="" /></div>

   <!-- form wrapper -->
   <div id="form_wrapper">

    <!-- form -->
    <form action="thankyou.php" method="POST">
     <!-- ... ... -->
    </form>
    <!-- /form -->
   </div>
   <!-- /form wrapper -->
  </div>
  <!-- /wrapper -->
 </body>

Posso quasi capire il  alla fine, perché è così lontano dall'inizio del tag / coppia ... ma seriamente, qual è il punto delle linee di commento di apertura? Non farei la domanda se non vedessi questo tutto il tempo .

Mi sento come se mi mancasse qualcosa. Forse c'è qualche buona pratica non scritta, anche se non riesco a capire cosa potrebbe essere. Più che probabile è solo un comportamento ossessivo-compulsivo.

Come ragazzi commentate normalmente il vostro markup, se mai?

html comments

posta Stephen 28.10.2010 - 00:06

fonte

6 risposte

6

L'HTML è come un codice compilato per me. È ottimizzato, non ha spazi, non ha commenti ed è il più piccolo possibile mentre viene svolto il lavoro. Tuttavia, ho alcuni commenti nei miei modelli che generano i file HTML. Non li vedrai mai, a meno che non ti unisci al team di sviluppo!

La stessa cosa vale per JavaScript. Qualsiasi JS che vedi sul mio sito è compresso, minimizzato e ha rimosso i commenti. I commenti sono per lo sviluppo, non per lo spreco di larghezza di banda!

risposta data 28.10.2010 - 01:36

fonte

4

Di solito il mio markup è generato dinamicamente quindi i commenti non sono inclusi ... ma quando scrivo markup avrò:

<!-- start BLOCK--> 
  html markup 
<!-- close BLOCK-->

Rende più facile per me vedere dove i blocchi principali / div sono nel mio codice.

risposta data 28.10.2010 - 00:11

fonte

2

Credo che ciò derivi da documenti che non hanno un'indicazione adeguata. Quindi, se non puoi dire dove ti trovi dalla colonna in cui ti trovi, la cosa migliore da fare è guardare i commenti. Sembra essersi evoluto da questo dilemma.

Personalmente, vorrei entrare nelle persone che non identificano il codice.

risposta data 20.01.2012 - 19:05

fonte

1

Posso solo pensare a un caso d'uso valido per questo: modelli HTML parziali.

Se si tratta di una pagina HTML completa, dovresti indentare correttamente per facilitare l'identificazione quando gli elementi iniziano e finiscono. Gli editori decenti evidenziano anche le estremità opposte dei tag. In questi casi, i commenti estranei sono fastidiosi.

Se si tratta di un modello parziale (intestazione e piè di pagina, ad esempio), quindi se si aprono alcuni contenitori di pagine, può essere utile visualizzarlo nel piè di pagina dove finisce.

intestazione

<div id="header">
    ...
</div>
<div id="contentContainer">
    <div id="content">

piè di pagina

    </div> <!-- /#content -->
</div> <!-- /#contentContainer -->
<div id="footer">
    ...
</div>

In casi (forse più complessi) come questo, avere i commenti è abbastanza utile per vedere quale tag dovrebbe chiudere. Questo è l'unico caso in cui mi sono imbattuto in cui non mi importa di questi commenti, però, si sentono ancora sporchi.

risposta data 20.01.2012 - 19:36

fonte

1

Questo è utile se la pagina è resa da più file / modelli diversi, ecc.

Qualcosa del genere:

<?php

echo "<!-- sidebar -->\n";
include("sidebar.php");  
echo "<!-- /sidebar -->";
# Or better yet, put the HTML comments *inside* sidebar.php
?>

In tal modo, se noti qualcosa di strano nel codice HTML visualizzato, puoi rintracciare rapidamente il codice che lo ha creato.

risposta data 20.01.2012 - 20:12

fonte

Leggi altre domande sui tag html comments

I tester devono guardare il codice sorgente? Che cosa dice freelance a lungo termine sull'esperienza di uno sviluppatore? [chiuso]

score 9 · Accepted Answer

Alcune volte i nomi delle classi CSS sono generici e non sono specificatamente nominati. Ad esempio, cosa succede se avessi

<!--Code before-->



<!--Column one-->
<div class="center-bold">




    <!--Tons of lines-->




</div>
<!--End column-->

Non sarebbe bello sapere che cosa stai iniziando? Sicuramente non vorrei scorrere fino alla fine per scoprire che l'intero div era una colonna.