OctoberCMSテーマ作成Tips：ページファイルにコメントを記述する

結論から書くと、ページファイルのページ設定セクションでは;でインラインコメントを書ける。

ページファイルは、ページ設定セクション、PHPコードセクション、そしてテンプレートセクションで構成される。PHPコードとテンプレートセクションでは言うまでもなくそれぞれの言語のコメントシンタックスが使用できるが、わからなかったのがページ設定セクション。

ページ設定セクションについてはあまりドキュメントでは説明されていないが、このセクションはINIファイルフォーマットが適用されている。

INIファイルでは ; でインラインコメントを開始できるので、ここでもそれが使える。

例

; ブログ記事ページ
title = "Blog Post" ; タイトル
url = "/blog/post/:slug" ; `:slug`は記事IDのようなもの
layout = "default"
is_hidden = 0

[blogPost]
slug = "{{ :slug }}"
categoryPage = 404
==
{% component 'blogPost' %}

OctoberCMSのINIパーサーのAPIドキュメントにさらに詳細が書いてあるのでご参考までに。