Come posso commentare in CoffeeScript? “/ * This * /” non funziona

142

In che modo puoi commentare in CoffeeScript?

La documentazione afferma che è possibile utilizzare tre simboli hash per avviare e chiudere un blocco di commenti:

###
  Comments
  go
  here
###

Ho scoperto che a volte posso usare i seguenti due formati

`// backticks allow for straight-JavaScript,
 // but the closing backtick can't be on a comment line (I think?)
`

Esiste un modo più semplice per inserire brevi commenti in CoffeeScript?

NON utilizzare questo stile **

Dal momento che questo sta ottenendo molti punti di vista, voglio sottolinearlo

/* Comment goes here */

produce un errore MATH quando /*è sulla propria riga.

Come ha sottolineato Trevor in un commento sulla domanda, questa è un'espressione regolare , NON un commento!

— Eric Hu
fonte

Se un /*...*/commento "funziona", è perché il compilatore CoffeeScript lo sta interpretando come regex. Sicuramente sconsigliato!

— Trevor Burnham,

Quindi suppongo che NON SIAMO MODI in CoffeeScript per avere un commento all'interno della frase (tra i caratteri)?

— Pete Alvin,

Risposte:

267

Usa un singolo segno #

# like this

Un personaggio sembra piuttosto minimale;)

Anche:

###
This block comment (useful for ©-Copyright info) also gets 
passed on to the browsers HTML /* like this! */
###

— Michael Durrant
fonte

Di solito è così che vorresti commentare; l'hash triplo viene spesso utilizzato quando si desidera che il commento passi al javascript (messaggi di copyright, di solito).

— Aaron Dufour,

Ah sospiro . I documenti ufficiali usano il singolo modulo # per tutti i loro esempi, ma non lo menzionano mai nelle spiegazioni del testo, parlano solo dei commenti di blocco.

— Gerry,

Sfortunatamente non c'è modo di avere commenti di blocco che non vengono visualizzati nell'output.

— nilskp,

Il modo principale per commentare è sh / Perl / Ruby / ... #commenti di stile :

# This comment goes to the end of the line
# and it won't appear in the "compiled"
# JavaScript version.

Si utilizzano i commenti in stile blocco### quando si desidera visualizzare un commento nella versione JavaScript:

A volte desideri passare un commento di blocco al JavaScript generato. Ad esempio, quando è necessario incorporare un'intestazione di licenza nella parte superiore di un file. I commenti di blocco, che rispecchiano la sintassi per heredocs, vengono conservati nel codice generato.

Quindi se inizi con

###
PancakeParser is Public Domain
###

allora otterrai questo commento JavaScript nel JavaScript generato:

/*
PancakeParser is Public Domain
*/

— mu è troppo corto
fonte

Diffidare di ###! Se usi ### per separare sezioni di codice (come faccio io) è terribilmente sorprendente quando quel codice smette di funzionare di conseguenza.

— Mark Wilden
fonte

Sai perché? Il codice funziona localmente ma non sul server di build con ###.

— Azat,

Sfortunatamente, l'ho notato mesi fa, e non sono "in quello spazio" in questo momento per dare un'occhiata.

— Mark Wilden,

Perché una coppia fa un commento in blocco?

Non sarebbe così sorprendente se tu usassi un editor di evidenziazione della sintassi, con commenti che appaiono in un colore diverso

— Nick Perkins,

Perché votare? È un avvertimento valido. In realtà, sta dicendo di non usare una linea continua di # come separatore di sezione, oppure potresti occasionalmente ottenere coppie di commenti di blocco sbilanciati.

— Jim Mack,