Posted at
CMakeDay 3

CMake: コメント

More than 3 years have passed since last update.


はじめに

みなさん、こんにちは。今回は、コメントについて書いていきます。

実は CMake のコメントは以下の2種類あり、それぞれ違う特徴を持っています。


Line Comment

まず、Line Comment からですが、

これは#文字から始まるコメントで、行末までが有効範囲になります。

普段はこちらを使うことになるでしょう。

message(a) # aと出力する


Bracket Comment

次に、Bracket Comment ですが、これは CMake 3.0 から追加されたコメントで、前回のコマンド引数の記事で示した Bracket Argument と似た構文を持っています。つまり、#文字の直後の、二重の対となるブラケット[[]]で囲われていて、ブラケットの間に任意の数の等号=をいれることができます。この等号=の数は対となるブラケットで同じでなければなりません。

message(a) #[[aと出力する]]

message(a) #[=[aと出力する]=]
message(a) #[==[aと出力する]==]

この Bracket Comment は次のように複数行に書くことができます。

message(a) #[[

aと出力する
]]

また、引数の間に書くこともできます。

message(a #[[値a]] b #[[値b]])

=の数を変更すれば、ネストしたコメントアウトにも使えます。

#[[

message(a)
#[=[
message(b)
#[==[
message(c)
]==]
]=]
]]


おわりに

以上、コメントについてでした。CMake 3.0 で追加された Bracket Comment は複数行に渡るコメントを書くときに便利そうですね。

明日は、mrk_21 さんの『CMake: 変数』です。