Scribble at 2021-02-26 19:33:49 Last modified: 2021-03-01 09:45:14
設定ファイルのディレクティブは大文字小文字を区別しませんが、 引数にはしばしば区別するものがあります。ハッシュ文字 "#" で始まる行はコメントと見なされて無視されます。 設定ディレクティブと同一行の末尾にコメントが含まれていてはいけません。ディレクティブの前の空行と空白は無視されますので、 わかりやすくするためにディレクティブをインデントしても構いません。
Raspberry Pi OS Lite のセットアップについて書いた記事でも指摘したことだが、ウェブ・ページの整形として見栄えが優先されている可能性はあるので、ウェブ・ページのコード画面みたいなプレゼンテーションで表示されている箇所を設定ファイルにコピペするのは推奨できない。（もちろん、当サイトで掲載しているコードの事例についても言える。）
特に Apache 関連でよく見るのが、本来の設定ファイルではやってはいけないことをウェブ・ページで公開するコードの補足としてやってしまうというものだ。つまり、ディレクティブのパラメータの後にコメントを付けて、ディレクティブの意味を説明するという体裁にしてしまうのである。たとえば、こんなふうに。
ServerRoot "C:/Development/Apache" # httpd がインストールされたパス
これは、実際にこういうコメントを httpd.conf に書いて httpd.exe -t を実行するだけで間違いだと分かる筈だ。
httpd.exe: Syntax error on line 1 of C:/Development/Apache/conf/httpd.conf: ServerRoot takes one argument, Common directory of server-related files (logs, confs, etc.)
しかし、ブログ記事などを書くために後から挿入した文言であり、そして他のプログラミング言語のような感覚で同じようにコメントを書いているため、まさかそれのせいで起動しなくなるとは夢にも思わない人がいたりする。設定ファイルにも当然だが構文があり、必ずしもインデントやコメントの位置が自由な構文とは限らないという点を改めて強調したい。