各言語のコード内や、各サービスの設定ファイル内でコメントアウトする方法をまとめてみました。
C言語、C++、C#
1 2 3 4 5 6 |
// コメント /* 複数行コメント 複数行コメント */ |
CSS
1 2 3 4 5 6 |
/* コメント */ /* 複数行コメント 複数行コメント */ |
Go
1 2 3 4 5 6 |
// コメント /* 複数行コメント 複数行コメント */ |
HTML
1 2 3 4 5 6 |
<<!-- コメント --> <<!-- 複数行コメント 複数行コメント --> |
Java、JavaScript
1 2 3 4 5 6 |
// コメント /* 複数行コメント文 複数行コメント文 */ |
Perl
1 2 3 4 5 6 7 8 9 |
# コメント # 複数行コメント # 複数行コメント =pod 複数行コメント 複数行コメント =cut |
PHP
1 2 3 4 5 6 7 8 |
// コメント # コメント /* 複数行コメント文 複数行コメント文 */ |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
# コメント # 複数行コメント # 複数行コメント ''' 複数行コメント 複数行コメント ''' """ 複数行コメント 複数行コメント """ |
※「'''」および「"""」は疑似コメントアウトです。あくまで疑似的にコメントのように扱うだけなので、利用する場合はブロックの中でインデントを揃える必要があります。
Ruby
1 2 3 4 5 6 7 8 9 |
# コメント =begin 複数行コメント 複数行コメント =end __END__ 以降を全てコメント |
SQL文
1 2 3 4 5 6 |
-- コメント /* 複数行コメント 複数行コメント */ |
シェルスクリプト
1 2 3 4 5 6 |
# コメント << COMMENTOUT 複数行コメント 複数行コメント COMMENTOUT |
※複数行コメントの「COMMENTOUT」は別の文字列でもOKです。「<< 指定した文字列」~「指定した文字列」までがコメントとして認識されます。
各サービスの設定ファイル等
Apache(httpd.conf .htaccess等)
1 2 3 4 |
# コメント # 複数行コメント # 複数行コメント |
BIND(named.conf等)
1 2 3 4 5 6 7 8 |
// コメント # コメント /* 複数行コメント 複数行コメント */ |
cron(crontab)
1 2 3 4 |
# コメント # 複数行コメント # 複数行コメント |
Dovecot(dovecot.conf等)
1 2 3 4 |
# コメント # 複数行コメント # 複数行コメント |
Nginx(nginx.conf等)
1 2 3 4 |
# コメント # 複数行コメント # 複数行コメント |
PHP(php.ini等)
1 2 3 4 |
; コメント ; 複数行コメント ; 複数行コメント |
Postfix(main.cf等)
1 2 3 4 |
# コメント # 複数行コメント # 複数行コメント |
ProFTPD(proftpd.conf等)
1 2 3 4 |
# コメント # 複数行コメント # 複数行コメント |
vi、vim(.exrc .vimrc)
1 2 3 4 |
; コメント ; 複数行コメント ; 複数行コメント |
まとめ
コードを書く場合は後々の可読性を高めるために、こまめにコメントを入れておきましょう。
設定ファイルを変更する際も、変更日時や変更内容、デフォルト値などをコメントで残しておくと後々便利です。