| Home |
2013.11.09
コメントとコメントアウトは人間が読む文章を書くのにも便利だぞ
今日は文章を書くことを、作業面から助ける提案を。
知っている／やっている人には当たり前すぎる話だが、知ると知らないとでは執筆中の効率の面でも精神衛生の面でも大違いなので書く。
コメントとは何か？
プログラミング言語を用いてコンピュータに何か有用な作業をさせるための指示を書き上げることをプログラミングといい、書かれた指示のかたまりをソースコードという。
ソースコードには、コンピュータが処理を行うときには〈ないもの〉扱いされる（つまり処理されることなく飛ばされる）が、覚え書きとしてコメント（comment）があちこちに挿入されることが多い。
たとえばC++やJavaでは// 以降がコメントと見なされ、PerlやPythonでは、# 以降がコメントと見なされる。
またHTML、Wikiでは、で括られた部分がコメントと見なされ、C、C++、Java、JavaScript、CSSでは、/* と */ で括られた部分がコメントと見なされる。
重要なのは、コメントが、コンピュータには無視されるものであり、もっぱら人間のために書かれていることだ。
コメントが必要な理由は、他人が書いた場合や、自分が書いたものでも時間をおいてから読む場合には、なんでこんなソースコードになっているのか、その意図を理解するのが難しいからである。
このためソースコードを書く人（プログラマー）は、このステップで何をしようとしているのか／何をさせたいのか、その意図などをコメントとして、ソースコードのそこ・ここに埋め込んでおく｡
思考過程を書き残す
さて、人間が読むことになる文章を書く場合にも、このコメントを挿入しながら書いていくことを強力におすすめする。
理由はコンピュータが読むソースコードの場合と同じ。
たとえ書いた本人であっても、時間をおいてから読んだ場合には、本文だけを読んでもその意図を分からなくなる場合があるからだ。とくにいろいろ考え迷いながら、こんがらがりながら下書きを書いている場合はそうだ。
文章のあちこちで、ここはどういうつもりで、本当は何を書きたくて書いているのか、思考の跡をコメントとして残しながら書くといい。
「ここはもっといい例は無いのか？」
「前の章と矛盾してる？」
「ここまで言うのは言い過ぎでは？」
みたいな本音とか頭の中のぶつくさ（ツッコミ、自己添削、悲嘆など）をメタ・レベルの記述として、本文とは区別できるようにして残しておくのだ。
◯思考過程をコメントとして残しながら書いている例
#の後ろ（緑色の部分）がコメント
Macintosh対応のCotEditorで、Perlのカラーリングを使用。
選択肢をとっておく
コメントをつかった書き方は、他にもよいところがある。
最初から完成品を書こうとすると、これで本当にいいのかと、書く手が怖気づく。
何通りもの書き方を思いついても、どれにすればいいか考え出し決めきれないと手が止まる。そんな時はすべて書き出しておいて「あとで選ぶ」とコメントしておけばいい。そして結局選ばれないものは、いつの段階でもコメント扱いしておけば、最終稿では本文に残らない。
この、完全に消してしまうかわりに、コメント扱いすることで「ないことにする」のをコメントアウト（comment out）という。
逆にコメント扱いをやめ、やっぱり使うことにするのをアンコメント（uncomment）といったりもする。
コメントアウト／アンコメントをうまく使えば、迷って決め切れずに手が止まる事態を避けて、先に進むことができる。
表に出せないことを書き残す
コメントはさらに「本文には書いてはいけないこと」を忘れずにメモしておく場合にも使える。
伏線だとか、表に出せない（出さない方がいい）設定などは、コメントとして残しておけば忘れないし、意識しながら書き進むことができる。
話を面白くないものにする秘訣はすべてを語ることだと、ボルテールも言っている。
アウトラインを流し込む
書きながら挿入していくコメント本来の使い方とは少し違うが、あらかじめアウトラインができている文章（たとえば論文系の書き物）だと、アウトラインをコメントの形で流し込んで、その間に本文を挿入しながら書いていくこともできる。
つまりアウトライン＝意図（何を書くべきか？なぜ書くべきか？）の覚え書き、と考えてコメントとして扱う訳だ。
アウトラインは最終稿でも章や節の見出しとして残ることも多いが、トピックセンテンスとして本文に溶け込むこともあり、また表に出る見出しには別の表現を使ったほうがよい場合もある。こうした場合は、アウトラインから持ち込んだフレーズはコメントアウトすればいい。
何を書きたかったか／書くべきだったかはコメントの形で残るから、あとでもっと良いトピックセンテンスなり見出しに書きなおす場合や、複数の候補ができる場合にガイドとして役立つ。
◯アウトラインをコメントとして流し込み、そのあと本文を書いた例
#の後ろ（緑色の部分）がコメント
Macintosh対応のCotEditorで、Perlのカラーリングを使用。
このように人間が読む文章の下書きには、コメントは様々な目的で使える。
最初に述べたとおり、コメントはソースコードを書く際の作法だから、ソースコードを書くための多くのテキストエディタには、コメントに関する機能（選択部分をコメントしたりコメントを外したり、コメントになっている部分の色を変えたりする）を備えている。
以下にフリーで利用できるテキストエディタをいくつか挙げた。
Windows対応
・サクラエディタ
・TeraPad
Macintosh対応
・CotEditor
・mi
Windows、Mac、Linux対応
・Sublime Text
・GNU Emacs
これらのテキストエディタは検索／置換に正規表現が使えるから、たとえば#で始まるコメント行をすべて消して最終稿をつくるには
（置換文字列は空）
として「すべて置換」や「一括置換」（Replace All)すればいい。
知っている／やっている人には当たり前すぎる話だが、知ると知らないとでは執筆中の効率の面でも精神衛生の面でも大違いなので書く。
コメントとは何か？
プログラミング言語を用いてコンピュータに何か有用な作業をさせるための指示を書き上げることをプログラミングといい、書かれた指示のかたまりをソースコードという。
ソースコードには、コンピュータが処理を行うときには〈ないもの〉扱いされる（つまり処理されることなく飛ばされる）が、覚え書きとしてコメント（comment）があちこちに挿入されることが多い。
たとえばC++やJavaでは// 以降がコメントと見なされ、PerlやPythonでは、# 以降がコメントと見なされる。
またHTML、Wikiでは、で括られた部分がコメントと見なされ、C、C++、Java、JavaScript、CSSでは、/* と */ で括られた部分がコメントと見なされる。
重要なのは、コメントが、コンピュータには無視されるものであり、もっぱら人間のために書かれていることだ。
 Java のソースコードの例。 // の後ろはコメントになる（緑の部分：行コメント） /* と */ で括られた部分もコメント（赤の部分：ブロックコメント） |
コメントが必要な理由は、他人が書いた場合や、自分が書いたものでも時間をおいてから読む場合には、なんでこんなソースコードになっているのか、その意図を理解するのが難しいからである。
このためソースコードを書く人（プログラマー）は、このステップで何をしようとしているのか／何をさせたいのか、その意図などをコメントとして、ソースコードのそこ・ここに埋め込んでおく｡
思考過程を書き残す
さて、人間が読むことになる文章を書く場合にも、このコメントを挿入しながら書いていくことを強力におすすめする。
理由はコンピュータが読むソースコードの場合と同じ。
たとえ書いた本人であっても、時間をおいてから読んだ場合には、本文だけを読んでもその意図を分からなくなる場合があるからだ。とくにいろいろ考え迷いながら、こんがらがりながら下書きを書いている場合はそうだ。
文章のあちこちで、ここはどういうつもりで、本当は何を書きたくて書いているのか、思考の跡をコメントとして残しながら書くといい。
「ここはもっといい例は無いのか？」
「前の章と矛盾してる？」
「ここまで言うのは言い過ぎでは？」
みたいな本音とか頭の中のぶつくさ（ツッコミ、自己添削、悲嘆など）をメタ・レベルの記述として、本文とは区別できるようにして残しておくのだ。
◯思考過程をコメントとして残しながら書いている例
#の後ろ（緑色の部分）がコメント
Macintosh対応のCotEditorで、Perlのカラーリングを使用。
選択肢をとっておく
コメントをつかった書き方は、他にもよいところがある。
最初から完成品を書こうとすると、これで本当にいいのかと、書く手が怖気づく。
何通りもの書き方を思いついても、どれにすればいいか考え出し決めきれないと手が止まる。そんな時はすべて書き出しておいて「あとで選ぶ」とコメントしておけばいい。そして結局選ばれないものは、いつの段階でもコメント扱いしておけば、最終稿では本文に残らない。
この、完全に消してしまうかわりに、コメント扱いすることで「ないことにする」のをコメントアウト（comment out）という。
逆にコメント扱いをやめ、やっぱり使うことにするのをアンコメント（uncomment）といったりもする。
コメントアウト／アンコメントをうまく使えば、迷って決め切れずに手が止まる事態を避けて、先に進むことができる。
表に出せないことを書き残す
コメントはさらに「本文には書いてはいけないこと」を忘れずにメモしておく場合にも使える。
伏線だとか、表に出せない（出さない方がいい）設定などは、コメントとして残しておけば忘れないし、意識しながら書き進むことができる。
話を面白くないものにする秘訣はすべてを語ることだと、ボルテールも言っている。
アウトラインを流し込む
書きながら挿入していくコメント本来の使い方とは少し違うが、あらかじめアウトラインができている文章（たとえば論文系の書き物）だと、アウトラインをコメントの形で流し込んで、その間に本文を挿入しながら書いていくこともできる。
つまりアウトライン＝意図（何を書くべきか？なぜ書くべきか？）の覚え書き、と考えてコメントとして扱う訳だ。
アウトラインは最終稿でも章や節の見出しとして残ることも多いが、トピックセンテンスとして本文に溶け込むこともあり、また表に出る見出しには別の表現を使ったほうがよい場合もある。こうした場合は、アウトラインから持ち込んだフレーズはコメントアウトすればいい。
何を書きたかったか／書くべきだったかはコメントの形で残るから、あとでもっと良いトピックセンテンスなり見出しに書きなおす場合や、複数の候補ができる場合にガイドとして役立つ。
◯アウトラインをコメントとして流し込み、そのあと本文を書いた例
#の後ろ（緑色の部分）がコメント
Macintosh対応のCotEditorで、Perlのカラーリングを使用。
このように人間が読む文章の下書きには、コメントは様々な目的で使える。
最初に述べたとおり、コメントはソースコードを書く際の作法だから、ソースコードを書くための多くのテキストエディタには、コメントに関する機能（選択部分をコメントしたりコメントを外したり、コメントになっている部分の色を変えたりする）を備えている。
以下にフリーで利用できるテキストエディタをいくつか挙げた。
Windows対応
・サクラエディタ
・TeraPad
Macintosh対応
・CotEditor
・mi
Windows、Mac、Linux対応
・Sublime Text
・GNU Emacs
これらのテキストエディタは検索／置換に正規表現が使えるから、たとえば#で始まるコメント行をすべて消して最終稿をつくるには
検索文字列
置換文字列
（置換文字列は空）
として「すべて置換」や「一括置換」（Replace All)すればいい。
- 関連記事
-
- 書くことは何故苦しいのか？ スランプを破壊するいくつかの方法
- 長い文章を書く人のためにアウトラインプロセッサの基本をまとめてみた
- コメントとコメントアウトは人間が読む文章を書くのにも便利だぞ
- 書く力を本当に倍増する、容易くはない５つのトレーニング
- 無料でここまでできる→日本語を書くのに役立つサイト２０選まとめ
| Home |