PL/SQLの勉強3 コメントについて
プログラムを書くにあたって
忘れてはいけない機能があります。
それは「コメント」です。
- コメントはどうやって書くのか？
- コメントってなぜ必要？
を今回はお話ししていこうと思います。
コメントとは何なのか？
例えば前回やったPL/SQLは以下のようなものです。
declare
v_str varchar2(10);
begin
v_str := 'Hello World';
dbms_output.put_line(v_str);
end;何をやっているのかは、何となくわかると思います。
しかし、例えばこれが1000行とか長くなってしまうと「ここって何やろうとしたんだっけ〜」ってなってしまいます。
プログラムを1行ずつ読むのはとても面倒です。それよりは日本語が書いてあった方が「ここら辺はこんなことしてるんだ！」と分かりやすくなります。
そんなことをするために「メモ（コメント）を残しておく！」という機能があるんです。
コンピュータはコメントを無視します。
だから長文の思いの丈を書くことだってできます！
コメントの書き方
コメントの書き方は２種類あります。
- 行コメント
- ブロックコメント
それぞれの書き方を見ていきましょう。
行コメント
行コメントは以下のように書きます。
declare
v_str varchar2(10);
begin
-- 行コメント
v_str := 'Hello World';
dbms_output.put_line(v_str);
end;4行目にあるやつで、最初に「–」つまりハイフンを2回書きます。
すると、それ以降の行の最後までコメントになります。
「–」以降がコメントになりますので
以下のように書くこともできます。
declare
v_str varchar2(10);
begin
-- 行コメント
v_str := 'Hello World'; -- ここにだって書けるよ！
dbms_output.put_line(v_str);
end;ブロックコメント
コメントにはもう１種類の書き方もあります。
それがブロックコメントというものです。
以下のように書きます。
declare
v_str varchar2(10);
begin
/*
ブロックコメント
この中だったら何行だって書けるよ！
*/
v_str := 'Hello World';
dbms_output.put_line(v_str);
end;「/*」つまりスラッシュ・アスタリスクで始まり
「*/」つまりアスタリスク・スラッシュで終わります。
この中に入っていれば
何行あっても全部コメントになります。
なんでコメントを書くのか？
プログラムに影響のないコメント。
何でこんなものを書く必要があるのでしょうか？
この理由はいくつかあります。
自分だけがプログラムをお守りするわけじゃない
プログラムは何のためにあるんでしょうか？
単純明快ですよね。
いつもやっていた面倒な作業を効率的に・素早く終わらせるためです。
ってことは、長い期間・多くの人に使われるプログラムがとてもいいものである、というのは分かると思います。
長い期間使われていると、そのうち仕様の変更があったりします。
そうすると、自分が書いたプログラムでも他の人がプログラムを書き換えることはよくあります。
そんな時…
プログラムを1行ずつ読み進めなきゃいけないのは効率が悪すぎますよね。。。
そんなことを防止するためにコメントを書くんです。
- ここでは〇〇をしようとしているよ！
- ここの処理ではこんなデータが来るのが前提にあるよ！
とか書いてあると初めてプログラムを読む人にとって優しいですよね！
「2ヶ月前の自分」は他人w
僕、すっごく物覚えが悪いんです。
というか、過ぎたことは忘れちゃうｗ
仕事で扱うプログラムについてもそうで、過去に作ったプログラムも「そんな変更したっけ！？」って思っていろんなメモを漁るほどｗ
上司にもよく、少し前にやったじゃん！って言われます♪
プログラムを見ても「ん〜？覚えてない…」なんて事態によくなってます。
その時に役立つのがコメントです！
プログラムを書いていた時の思いの丈を書いておくことで過去に何が問題となっていたのか？を思い出すことができます。
いちいち色んなドキュメントを漁るのは面倒です。
だったらその時の思いの丈を思いっきり書きまくればいいんです！
以上ですｗ
今回はつらつらとコメントに対する僕の思いを語ってみました。
文章的にはまとまってないと思います。。。
でも「コメントって大切なんだ〜」とか「なんかしら書いておこうかな」って思ってくれたらこの記事の意味はあったのかな！って思えます。
人に対して優しいプログラムを…
つまり、何しているのかを分かりやすいようにコメントは書きましょう、ということでした♪