プログラミングについて久しぶりに書きます。
プログラミングの書き方って人それぞれですが
それ相応のコーディング規約みたいなものの上で
プログラミングを行っているでしょう。
プロの方はプロジェクトである一定のルールがあるでしょうし、
(コーディング規約って奴ですね)
趣味で行っている方でも漠然と自分の中で
決めている事があると思います。
その中でコメントの書き方について触れてみたいと思います。
そもそもコメントって必要なのでしょうか?
この問が全てなのですが、
常識論や一般論を抜きにして考えて欲しいのですが
必要ないって人も実際いるのではないでしょうか?
趣味で行ったいる方は特にこの考え方があるようですが
コメントというのは簡単に行ってしまえば、
プログラミング言語で書かれている上、下、横といったところに
母国語で書くメモの事です。
つまりプログラミング言語で通用する部分には
コメントなんていらないのです。
コメントを書けと教えられた会社の新人が
10行くらいのプログラムにコメントを付けていたのですが
はっきり言って無駄です!
10行程度であれば、母国語ではなく
プログラミング言語を読めば助けなく十分理解できるからです。
printfのコメントとして「標準出力に出力する」などど
コメントを書くのは非常にナンセンスです。いないと思いますが、
実際問題いるので触れてしまうのですが...
このprintfが「標準出力に出力する」なんてのは
コメントではなく関数説明です。
ようはこの辺りを混合してしまってコメントを書くと失敗するのです。
でもって私の結論はずばり
プログラムはコメントから書け!って事です。
母国語でプログラムを書くのではありません。
あくまでもコメントで関数概要、処理概要を書くのです。
その後にプログラムを書く。
プログラム記述ごにコメントが変更されるようであれば
設計ミスの可能性があります。
慎重にプログラムに落とす前に行った作業、
頭の中での整理を再度行うべきです。
今更ですが、以外といろいろな人がいますから
0 件のコメント:
コメントを投稿