Комментарии в Twain 2 SugarCube

 Комментарии - это способ добавлять пояснения или заметки в ваш код, которые не отображаются в игре. Синтаксис комментариев зависит от того, какой формат истории вы используете в Twine 2. Если вы используете SugarCube, то вы можете использовать следующие способы добавлять комментарии в пассажи¹:

 

// Это однострочный комментарий на JavaScript. Он полностью удаляется из сгенерированного HTML.

 

/* Это многострочный комментарий на JavaScript. Он также полностью удаляется из сгенерированного HTML. */

 

<!-- Это однострочный комментарий на HTML. Он появляется в сгенерированном HTML, но не виден в игре. -->

 

<!-- Это многострочный комментарий на HTML.

Он также появляется в сгенерированном HTML, но не виден в игре. -->

 

Если вы используете Harlowe, то вы можете использовать только комментарии на HTML²³. Например:

 

<!-- Это однострочный комментарий на Harlowe. Он полностью удаляется из сгенерированного HTML. -->

 

<!-- Это многострочный комментарий на Harlowe.

Он также полностью удаляется из сгенерированного HTML. -->

 

Вы можете добавлять комментарии в любом месте пассажа, где они не будут мешать вашему коду или тексту. Например:

 

// Это комментарий перед текстом

Вы находитесь в темной комнате.

// Это комментарий после текста

 

<<if $hasKey is true>> // Это комментарий внутри кода

Вы можете открыть дверь.

<</if>>

 

Источник: беседа с Bing, 7/1/2023

(1) How to comment - commenting syntax - Twine Forum. https://twinery.org/forum/discussion/5071/how-to-comment-commenting-syntax.

(2) [harlowe] How to add comments to my passages? - Twine Forum. https://twinery.org/forum/discussion/8598/harlowe-how-to-add-comments-to-my-passages.

(3) Twine 2.2: Learning Twine: Passage Links - YouTube. https://www.youtube.com/watch?v=RwN6JcWcP0s.

(4) A Total Beginner’s Guide to Twine 2.1 – Adam Hammond. https://www.adamhammond.com/twineguide/.
------------------------------------------------------------------------------------------------------------------------------------
И еще одно незатейливое объяснение от чудомашины:

Макросы - это специальные команды, которые начинаются и заканчиваются двойными угловыми скобками, например <<set>> или <<if>>. Они позволяют вам делать разные вещи в игре, такие как устанавливать переменные, проверять условия, создавать кнопки и т.д. Некоторые макросы требуют закрытия, то есть повторения их имени с обратным слешем перед ним. Например, макрос <<if>> должен быть закрыт макросом <</if>>. Это показывает, где заканчивается его действие. Например:

 

<<if $hasKey is true>>

Вы можете открыть дверь.

<</if>>

 

Если вы не закроете макрос, то он будет работать неправильно или вызывать ошибки. Вы можете узнать больше о макросах в документации SugarCube.