Як коментувати в CoffeeScript? "/ * Цей * /" не працює


142

Якими способами можна коментувати в CoffeeScript?

У документації говориться, що ви можете використовувати три хеш-символи для запуску та закриття блоку коментарів:

###
  Comments
  go
  here
###

Я виявив, що інколи можу використовувати наступні два формати

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

Чи є простіший спосіб вставити короткі коментарі в CoffeeScript?

НЕ використовуйте цей стиль **

Оскільки це отримує багато поглядів, я хочу наголосити на цьому

/* Comment goes here */

видає помилку MATH, коли /*перебуває у власній лінії.

Як зазначив Тревор у коментарі до питання, це регулярний вираз , НЕ коментар!


15
Якщо /*...*/коментар "працює", це тому, що компілятор CoffeeScript інтерпретує його як регулярний вираз. Однозначно не рекомендується!
Тревор Бернхем

1
Тож я думаю, що в CoffeeScript НІЧОГО НЕ МАЄТЕ коментувати внутрішній вислів (між символами)?
Піт Елвін

Відповіді:


267

Використовуйте один знак #

# like this

Один персонаж здається досить мінімальним;)

Також:

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

4
Зазвичай це ви хочете прокоментувати; потрійний хеш найчастіше використовується, коли ви хочете, щоб коментар потрапляв на javascript (повідомлення про авторські права, як правило).
Аарон Дюфур

5
Ах зітхання . Офіційні документи використовують єдину форму # через свої приклади, але ніколи насправді не згадуйте в текстових поясненнях, вони говорять лише про коментарі блоків.
Джеррі

1
На жаль, не існує можливості блокувати коментарі, які не відображаються у вихідних даних.
nilskp

24

Основний спосіб коментувати - #коментарі у стилі sh / Perl / Ruby / ...

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

Ви використовуєте коментарі в стилі блоку,### коли хочете, щоб коментар відображався у версії JavaScript:

Іноді ви хочете передати блоковий коментар до створеного JavaScript. Наприклад, коли потрібно вставити заголовок ліцензування у верхній частині файлу. Блоковані коментарі, які відображають синтаксис гередоків, зберігаються в створеному коді.

Тож якщо почати з

###
PancakeParser is Public Domain
###

тоді ви отримаєте цей коментар на JavaScript в створеному JavaScript:

/*
PancakeParser is Public Domain
*/

4

Остерігайся ###! Якщо ви використовуєте ### для розділення розділів коду (як і я), це дивно дивно, коли цей код перестає працювати в результаті.


Ти знаєш чому? У нас код працює локально, але не на сервері збірки з ###.
Азат

На жаль, я це помітив місяцями тому, і я зараз не "в тому просторі", щоб подивитися на це.
Марк Уайлден

10
Тому що пара робить блоковий коментар?

3
Було б не так дивно, якби ви використовували редактор виділення синтаксису, а коментарі з’являються іншого кольору
Нік Перкінс,

4
Чому зворотний голос? Це дійсне попередження. Дійсно, це говорить про те, що не використовуйте суцільну лінію # як роздільник розділів, або ви можете час від часу отримувати незбалансовані пари блоку коментарів.
Джим Мак
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.