こんばんわ、コメントについて書かせていただく雄一です。 今回はCとか関係ないんですが、コメントって書くのへたくそな人いますよね？ってことから始まります。
当然ですね、「ほとんど毎行コメント」の人とかいますが、丁寧で時間もかけているけれど、だいたいコメントが多いほど読む気がしませんね。 ということで量は重要ではないです。 ただ、何もないよりましだとは思いますけれどね。 だいたい、「a++」とかいう行に、「aに1を足す」とかコメント書く馬鹿がいますが、読めばわかるっつーの。 といいたくなるようなコメントもいりません。
読み手が不安になるようなセリフも控えてください。 アホかとおもいます。 不安になるんだったらしっかりテストしなさい。
面白いコメントを紹介します。 こんなソースを仕事で触らなければならなくなった人はご愁傷様です。
a++; // a++
1．コメントを書く価値がわかりません。
// wait(300); // wait(150); // wait(10); // wait(100); // wait(50); // wait(35); wait(40); // よし
2．いや、よくないから。
私がやる上でもっとも楽なコメントの書き方は、製作したときの気持ちを書く方法。 これがかなり楽だとおもってますし、個人的には評価も高めです。 仕事とかじゃなければ口語でいいです。
さらに、コメントを上から流し読むだけで、だいたいのフローチャートが作れるくらいだと素敵です。 これは、アルゴリズムの流れを作っている「制御文」では必ず一行は書くようにするとよいです。 その際に、どのように制御しているか？を書いてはいけません。そんなのは読めばわかります。 なぜ制御するのか？を書くことが大事です。 制御するのですから、なにか思うこともあるでしょうし。
もっとランクの高いソースを目指すなら、変数の役目を書いておきましょう。 結構便利です。 違う名前で同じ用途の変数も防げますしね。
製作しているときはいいのですが、後からソースが読めなくなることがあります。 未来の自分は他人だと思うこと。 コメントは、まずは自分のために書いてください。 自分の理解できないコメントは他人が読めるわけがないですから。