Does WML support comment blocks?

[TheBladeRoden]

The "putting a # before every single line" method can get tedious after all.

[8680]

Code: Select all

#ifdef __UNUSED__
...
#endif

[Sapient]

I know some people used to put [comment][/comment] around a piece of WML to make it non-functional, because unrecognized tags were simply ignored.

However now it would probably trigger a warning about unrecognized WML.

[ancestral]

Setting an unused key shouldn't trigger any kind of warning, right?

Code: Select all

comment="
  This is a comment!
  It spans multiple lines as you can see.

  That's because it's really a string. But who cares!
"

You could also define a macro called COMMENT which does nothing, or even define _, and then you can write:

Code: Select all

{_ "
  This is another comment!

  Just like the above.
"}

[Iris]

You could also define a macro called COMMENT which does nothing, or even define _

Using _ will cause wmlxgettext to see each macro substitution instance as a translatable string and waste translators’ time.

Example:

WML:

Code: Select all

#textdomain wesnoth-test

#define _ STUFF
#enddef

{_ "test text"}

.pot:

Code: Select all

msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: http://bugs.wesnoth.org/\n"
"POT-Creation-Date: 2012-09-06 18:01-0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#: test.cfg:6
msgid "test text"
msgstr ""

It’s really more advisable to use #ifdef with an unlikely symbol, or just make it an actual block of commented-out lines. Some editors provide functions to do the latter in a much easier fashion, e.g. Kate (the “insert smart newline” action, Shift+Enter by default).