- - PR -
わかりやすいソースコードってどんなもの?
«前のページへ
1|2|3|4
投稿者 | 投稿内容 | ||||||||
---|---|---|---|---|---|---|---|---|---|
|
投稿日時: 2004-04-28 15:27
構成の問題が最も分かりにくくする要因だと思いますね。論理テーブル設計と同じで あまりにも正規化しすぎると、ソース量は減っても、かえって分かりにくくなったし ますから... あと、コメントに関しては微妙ですね... 上級者が初心者を意識して、「教育」という要素があれば、動きそのもののコメント があったほうが良いのですが、「教育」要素ではないプログラムの場合、プログラムの 動きは、きっちり出来ていればコメントは不要だと思います。(見れば解る) が、「何をしているか」ではなくて「なぜそうするか」というようなコメント、 つまり仕様のようなコメントが欲しいと思うのですけどね。 極端な話、設計書が無い状態のとき、ソースから設計書が起こしやすいようなコメント があればと思うのです。(ソースから業務フローかシステムフローまで起こせれば言う 事無いのですけど...無理ですね(^^ゞ) | ||||||||
|
投稿日時: 2004-04-28 17:28
デバッグしやすいソースってのは
たいてい綺麗にみえるもんですがいかがでしょ。 構成がまとまっていなかったり、 適切なコメントがついていなかったり、 適切なクラス名、メソッド名がついていなかったりすると、 ソースを追い難い原因だと小生考えております。 | ||||||||
|
投稿日時: 2004-04-29 10:36
前の会社には、javaでいうところのjavadocですか?C#でいうところのXMLコメントファイルですか?コメントから仕様書を生成するツールを作っていたので、仕様書として恥ずかしくないコメントをつける、かつメンテすることが会社のルールだったのです。。。でも、ひと目、つまり20行程度いないで、メソッド名や変数名から何をしているかわかる場合は、処理内容のコメントをつけなかったりします。 [quote] tak3さんの書き込み(2004-04-28 12:57)より: ここまでやってる方って実際多いと思うのですよ。 でも、このあとの実装になると・・・ [/qoute] それは「設計をどの程度まで行うか」にもよると思います。これは「慣れ」もあるのかと思います。慣れれば、「この処理にはn個の手順が必要」というのが「経験的に」わかっています。その為、
は、「データベース接続という処理の為の一連の手順」となるのではないでしょうか。もちろん、これは随所でやるでしょうから、1つのメソッドにまとめて、メソッド内にこのコメントを書きたいところですが… そういえば、ふと疑問。皆さんはif文のコメントをどう書きますか?って、スレッド起こすか。。。 | ||||||||
|
投稿日時: 2004-04-29 13:59
unibon です。こんにちわ。
メンテナンスと言っても、 (1)バグを見つけて取り除くためだけのもの (2) 機能拡張や改造という複雑なもの に分けられると思います。(ただ、ここでのメンテナンスは暗に(1)でしょうか?) 上記(1)ならば、ぱっと見の見易さ・分かりやすさがあったほうが良いかもしれません。これを優先する場合は、できるだけフラットな構造にして、たとえばRDBなら非正規化してあったり、コードならネストは浅く、グローバル変数を多用するというのも手だと思います。こういうコードを見るときは過度であってもコメントがたくさんあったほうが良いのかもしれません。 一方で上記(2)ならば、ぱっと見の見易さよりもむしろアーキテクチャーの奇麗さや統一感(デザインパターンの使用等)が求められるかもしれません。こういうコードだと過剰なコメントがあってもあまり意味はなく、逆に見づらいだけかもしれません。 | ||||||||
|
投稿日時: 2004-05-06 13:08
はにまるです。
前投稿で
という発言があり、その後NAL-6295さんから、その具体的方法が提示されました。 個人的には、「ふ〜ん、そんな考えもあるな〜」と流していたのですが、 NAL-6295さんのHPで、その背景にある考えを読み、「おお!なるほど!」と感動してしまいました。 既に御存知の方もいらっしゃるとは思いますが、 「技術習得は、その背景を知る事で更なる知識を得る事が出来る」考えから、 図々しくもNAL-6295さんへ引用許可をPMで依頼し、ご好意によりOKを頂きましたので ここに、その文書を引用致します。
# NAL-6295さんへ、この場を借りてお礼申し上げます。 【注意】 1.@ITさんの引用タグを使い原文を直接引用しているので読み難いかもしれません。 その場合はリンク先へGO! 2.リンク先は個人のHPですので、時間の経過によりリンクが外れる場合が御座います。 | ||||||||
|
投稿日時: 2004-05-06 13:24
こんにちは。jmasuと言います。
母国語を使うとバグが劇的に減るという調査結果もあるので、一概に良い悪いはいえない感じですね。個人的には「ダサいから嫌い。」ですけど。 |
«前のページへ
1|2|3|4