• ベストアンサー

【プログラミング】美しいコメントの書き方

【プログラミング】美しいコメントの書き方 VBSでプログラムを作っています。 後で読み返したときに、他の人でも読めるように、 美しくというか、わかりやすい コメントの書き方を教えてください。

質問者が選んだベストアンサー

  • ベストアンサー
回答No.1

こんにちは。 コメントは「何をしているか?」ではなく、「何のためにしているか?」を書くべきだそうです・・・。 何をしているのかは、ソースを見ればわかるという事ですね。 かくいう私は、コメント書かない派ですが・・・。 理由は、プログラムをメンテしても、コメントを放置するパターンが多くて、結局意味がないどころか、かえって邪魔になるからです。

その他の回答 (1)

noname#140925
noname#140925
回答No.2

以下はJavaの例ですが、以下のようにファンクション毎に機能説明や引数、戻り値書いておけば良いです。 [参考]Javadoc - Wikipedia http://ja.wikipedia.org/wiki/Javadoc

関連するQ&A

  • プログラミング初心者です。

    プログラミング初心者です。 Visual Basicを勉強し始めようと考えているのですが、 Visual Basicのプログラムを書いたり実行したりするには 何か特別なソフトが必要なのでしょうか? VBSのようにメモ帳だけだといいんですが・・・ 詳しい方、宜しくお願いします。 パソコンはXPです。

  • 「//」でコメントアウトするプログラミング言語

    Rubtやpythonのコメントアウトは「#」ですが 「//」でコメントアウトするプログラミング言語を教えてください。 ご回答よろしくお願いします。

  • #の以後がコメントになるプログラミング言語は

    #の以後がコメントになるプログラミング言語は Perl以外にもありますか?

  • プログラミングとは

    こんにちは。最近プログラミングの勉強を始めた者です。 ごく簡単な入門書を読み終えたところで、私自身プログラミングの本質がまだよくわかっていないようです。 そこでお尋ねしたいのですが、 ・「プログラミングが出来る」とはどういうことなのでしょうか? ・「プログラミングを極めている人」というのはいらっしゃるのでしょうか? ・「実用的なプログラミング技術」とはどのようなものでしょうか?もしくは、どの程度のプログラミング技術が「使える技術」なのでしょうか? ・さまざまなプログラムが存在するようですが、就職などに際して「すべてを幅広く学ぶ」あるいは「もとめられるプログラムだけの理解を深める」とではどちらが賢明でしょうか? 漠然とした抽象的な質問で非常にお答えづらいかとは思いますがよろしくお願いします。

  • VBS=簡易プログラミング言語=簡単?

    VBAは多少わかるのですが、VBSはよくわからないため勉強したいのですが、 VBSと言うのは、スクリプト言語と言うものですよね。 スクリプト言語=簡易プログラミング言語との事なので、 VBなどに比べると、VBSは簡単なのでしょうか?

  • VBSは何を動かすためのプログラミング言語?

    VBA→オフィスを動かすためのプログラミング言語 と認識していますが VBSは何を動かすためのプログラミング言語でしょうか? windowsですか?

  • プログラミングの著作権に関してです

    プログラミングをするにあたって他の人が作ったプログラムを参考にして自分のプログラムに当てはめながら出来たプログラムは著作権的に大丈夫でしょうか。人のプログラムのいいとこどりをして作った場合です。 又、構造は同じで変数名とか書き方を全て書き換えた場合著作権侵害として訴えられますでしょうか。

    • ベストアンサー
    • Perl
  • プログラミング

    マシニング、プログラミングを初めて数ヶ月のものですが、よろしくお願いします。 他の人が作ったプログラムを今まで使用し、マシニングで加工してきましたが、最近は自分で穴加工を始め、輪郭加工がある、プログラムをCAD/CAMにて作ってます。ほとんどがDXFからで、単なる穴しかないものならばいいのですが、エンドミルを使用する輪郭加工になると、自分で経路を指定してプログラムを作ることになります。 ここでなのですが、プログラミングにすごく時間がかかってしまうのも問題なのですが、いまいち、どうやって、経路を指定してやって、どのような加工方法がこのときに適切かがいまいちわかりません。 どんどんプログラムを作っていけばいいのでしょうが、時間ばかりがかかるだけで・・・。 このような場合、どのようなことから取り組めばよいのでしょうか? よろしくお願いします。 また、使用してるのは 浜松合同です。

    • 締切済み
    • CAM
  • プログラミング言語の説明

    大学4年の者です.  プログラミング言語で作成したアプリケーションについての論文を作成しているのですが,プログラムの説明(変数や関数)についてはどのように説明を行えばよいでしょうか コメントを記載したソースコードを張り付ける方法も考えましたが,それだと文ではないだろうと考え辞めました. 関数の処理はかきつらねるべきなのか段落に番号を振ってわけるのかなど,同期にプログラミング言語を使った論文を書いている人がいないので困っています.

  • プログラミングをしていることで楽しかったこと。

    プログラミング経験の方に聞きますが、コンピューターを動かす「プログラム」を「プログラミング」していることで、 「楽しかったこと」 「良かったこと」 「嬉しかったこと」 ことは何がありますか? よろしくお願いします。

専門家に質問してみよう