I commenti HTML all'interno dei tag di script sono una best practice? [chiuso]

La seguente pratica è abbastanza comune nel JavaScript inline con cui devo lavorare:

<script type="text/javascript">
   <!--
       // Code goes here
   //-->
</script>

So che il punto è impedire ai browser incompatibili con JavaScript di eseguire il rendering dei sorgenti, ma questa è ancora una best practice oggi? La stragrande maggioranza dei browser utilizzati oggi può interpretare JavaScript; anche i dispositivi mobili moderni di solito non hanno problemi.

Per quanto riguarda il "perché no?" domanda: di recente ho dovuto dedicare diverse ore al debug di un problema in cui qualcuno aveva omesso il "//" davanti a un "->" alla fine di un tag di script nascosto in profondità in alcune pagine e questo causava JavaScript misterioso errori.

cosa fai? È ancora considerata una "best practice?"

La cosa importante è che oggigiorno, se un particolare browser supporta JavaScript o meno è irrilevante (chiaramente la grande maggioranza lo fa) - è irrilevante perché quasi tutti comprendono i blocchi di script, il che significa che sanno di ignorare JavaScript anche se non possono interpretalo.

Matt Kruse fornisce una spiegazione leggermente più dettagliata sul suo sito JavaScript Toolbox del motivo per cui non utilizzare specificamente commenti HTML all'interno di blocchi di script.

Citato da quella pagina:

Non utilizzare commenti HTML nei blocchi di script

Ai tempi antichi di javascript (1995), alcuni browser come Netscape 1.0 non avevano alcun supporto o conoscenza del tag script. Quindi, quando javascript è stato rilasciato per la prima volta, era necessaria una tecnica per nascondere il codice dai browser meno recenti in modo che non lo mostrassero come testo nella pagina. Il "trucco" consisteva nell'usare commenti HTML all'interno del blocco di script per nascondere il codice.

L'uso di commenti HTML nello script è dannoso

// DON'T do this! Code is just representative on how things were done
<script language="javascript">
<!--
   // code here
//-->
</script>

Nessun browser di uso comune oggi ignora il tag <script>, quindi non è più necessario nascondere il sorgente javascript. Infatti può essere considerato dannoso per i seguenti motivi:

• All'interno dei documenti XHTML, il sorgente sarà effettivamente nascosto a tutti i browser e reso inutilizzabile
• - non è consentito all'interno dei commenti HTML, quindi qualsiasi operazione di decremento nello script non è valida

Ho smesso di farlo. Ad un certo punto devi solo lasciare andare il tuo NCSA Mosaic.

Come da Raccomandazione W3C, è stato principalmente utile nascondere i dati dello script agli AGENTI UTENTI.

Citato dalla pagina W3c :

Inserimento di commenti negli script in JavaScript Il motore JavaScript consente alla stringa "<!--"di ricorrere all'inizio di un elemento SCRIPT e ignora ulteriori caratteri fino alla fine della riga. JavaScript interpreta "//" come l'inizio di un commento che si estende fino alla fine della riga corrente. Ciò è necessario per nascondere la stringa "->" dal parser JavaScript.

    <SCRIPT type="text/javascript">
<!--  to hide script contents from old browsers
  function square(i) {
    document.write("The call passed ", i ," to the function.","<BR>")
    return i * i
  }
  document.write("The function returned ",square(5),".")
// end hiding contents from old browsers  -->
</SCRIPT>

No, è una sbornia da una soluzione alternativa utilizzata quando l'elemento script è stato introdotto per la prima volta. Nessun browser non riesce a capire l'elemento dello script oggi (anche se lo interpreta come "Script che dovrebbe essere ignorato perché lo scripting è disattivato o non supportato").

In XHTML, sono attivamente dannosi.

Qualche tempo fa ho scritto qualcosa sulla sua storia .

Ho smesso di usarlo un po 'di tempo fa. Inoltre, secondo Douglas Crockford , puoi eliminare l'attributo type dai tag di script poiché l'unico linguaggio di scripting disponibile nella maggior parte dei browser è JavaScript.

Se stai digitando manualmente, ti suggerisco di usare sempre file js esterni, che aiuterebbero molto.

Per quanto riguarda la tua preoccupazione: la maggior parte dei browser oggi è sicura per JavaScript. Tuttavia a volte le persone possono scrivere semplici parser per recuperare direttamente un HTML - e devo dire che la citazione sicura è davvero utile per quei clienti. Anche alcuni client non JS come il vecchio Lynx ne trarrebbero vantaggio.

Se non includi testo letterale tra i tag di script, ovvero se carichi script da file src, puoi dimenticarti dei commenti.

Suggerirei di utilizzare una sezione CDATA, come descritto in questa domanda .

Ho smesso di farlo secoli fa. Non ne hai davvero bisogno al giorno d'oggi.

Non lo faccio ma l'altro giorno sono andato a validare il mio sito protetto da password su w3c. Quindi ho dovuto usare il loro metodo di input diretto. Si è lamentato del mio javascript, quindi ho rimesso i commenti in tutto andava bene.