- PR -

わかりやすいソースコードってどんなもの?

投稿者投稿内容
七味唐辛子
ぬし
会議室デビュー日: 2001/12/25
投稿数: 660
投稿日時: 2004-04-27 16:26
引用:

るぱんさんの書き込み (2004-04-27 16:02) より:
コメントをつけなくても中で何をしているかがわかる事って、一つの理想ですね。

では、ここで更に質問です。
どのようにしたらコメントを付けなくて済むのでしょうか?

個人的には、「一つの関数で複数の事をさせない」と言う事ではないかと考えてます。
いかがでしょう?





それはいえますね。一つの関数は一つのことをする これは鉄則だと思います。
taku
ぬし
会議室デビュー日: 2002/11/12
投稿数: 918
お住まい・勤務地: 墨田区→中野区
投稿日時: 2004-04-27 16:39
引用:

るぱんさんの書き込み (2004-04-27 16:02) より:
2.「コメントをつけないで済むソースコード」とはどんなソースコードか?


「名は体を表す」、これは必須ですね。
Wata
ぬし
会議室デビュー日: 2003/05/17
投稿数: 279
投稿日時: 2004-04-27 16:48
引用:

七味唐辛子さんの書き込み (2004-04-27 16:26) より:
引用:

るぱんさんの書き込み (2004-04-27 16:02) より:
どのようにしたらコメントを付けなくて済むのでしょうか?

個人的には、「一つの関数で複数の事をさせない」と言う事ではないかと考えてます。
いかがでしょう?



それはいえますね。一つの関数は一つのことをする これは鉄則だと思います。


私も賛成。そのためなら、1回で済むループを2回まわすことさえ厭わないですね。
(もちろん、そこがボトルネックでないならばですけど

ほんとに1000行を超えるメソッドとか勘弁してください
NAL-6295
ぬし
会議室デビュー日: 2003/01/26
投稿数: 966
お住まい・勤務地: 東京
投稿日時: 2004-04-27 16:57
NAL-6295です。

引用:


るぱんさんの書き込み (2004-04-27 16:02) より:
2.「コメントをつけないで済むソースコード」とはどんなソースコードか?




・変数名、関数名、クラス名を省略しない。
・それぞれが持っている役割を名前にする。
・名前は長くなっても良い。
・名前が長すぎると思ったら、役割を持ちすぎているので分解する。
・マジックナンバーを使わない。
・物語を書くようにコーディングする。
・定時で帰るようにする。
・余力を持つ。

といったところでしょうか。


[ メッセージ編集済み 編集者: NAL-6295 編集日時 2004-04-27 17:16 ]
まゆりん
ぬし
会議室デビュー日: 2002/08/12
投稿数: 539
お住まい・勤務地: よこはま
投稿日時: 2004-04-27 17:13
こんにちは、まゆりんです。
外がもの凄い風と雨で、会社から出られない状態です・・・

引用:

NAL-6295さんの書き込み (2004-04-27 16:57) より:

・変数名、関数名、クラス名を省略しない。
・それぞれが持っている役割を名前にする。
・名前は長くなっても良い。
・名前が長すぎると思ったら、役割を持ちすぎているので分解する。



これは良く分かります。
昔は短く済ませようと省略しまくってたんですが、
後になって見たら自分で書いた筈なのに内容が理解できなかった、なんて事もありました。

そう言えば、入社した時に教育係(?)だった先輩は
私が付けた変数名や関数名を全部ローマ字に変えていました。
(例:strTel → Dennwa みたいな・・・)
確かに読みやすいけど・・・・どうなんでしょ?

#脱字修正・・・

_________________

まゆりん@次Delphiって。。。

[ メッセージ編集済み 編集者: まゆりん 編集日時 2004-04-28 00:22 ]
あつしfx
大ベテラン
会議室デビュー日: 2002/04/08
投稿数: 104
お住まい・勤務地: XPできるところ
投稿日時: 2004-04-27 21:00
引用:

NAL-6295さんの書き込み (2004-04-27 16:57) より:
NAL-6295です。

・変数名、関数名、クラス名を省略しない。
・それぞれが持っている役割を名前にする。
・名前は長くなっても良い。
・名前が長すぎると思ったら、役割を持ちすぎているので分解する。
・マジックナンバーを使わない。
・物語を書くようにコーディングする。
といったところでしょうか。

[ メッセージ編集済み 編集者: NAL-6295 編集日時 2004-04-27 17:16 ]


PHPerですが、上記は良くわかります。
付け加えるとしたら、
・言語にマッチした書きかたをする。
ですかね。
クラスの意味がないクラスとか見てると、精神汚染されそうな気がします。
特効薬はUnitTest。

_________________
http://aglabo.com/ @Homepage
http://furukawa-select.com/mt/ @Blog
CHN
ぬし
会議室デビュー日: 2002/03/07
投稿数: 382
投稿日時: 2004-04-27 22:03
引用:

NAL-6295さんの書き込み (2004-04-27 16:57) より:

・変数名、関数名、クラス名を省略しない。
・それぞれが持っている役割を名前にする。
・名前は長くなっても良い。
・名前が長すぎると思ったら、役割を持ちすぎているので分解する。
・マジックナンバーを使わない。
・物語を書くようにコーディングする。


これにつきますね!
昔からコンピュータをやってこられた方(全員というわけではないです)には
なかなか理解できない人も結構いらっしゃいます。
昔には昔の時代背景があるので無理もないですが。。
継承すべき良い習慣と捨てるべき悪い習慣があることは意識してほしいですね。
みんなそうやってきたから、私もそうしようというはやめてほしいです。
考えてほしいですね。

_________________
太子
常連さん
会議室デビュー日: 2004/04/22
投稿数: 22
お住まい・勤務地: デスマで登る山の頂上
投稿日時: 2004-04-27 22:52
わかりやすいソースコードって、やっぱり社内の命名規約や組方にそった物が一番わかりやすい。
得意ぶっていろんな関数つかってるPGの方がバグだらけ。
使い回しきかない・・・
優れた開発者は、自分みたいなお馬鹿チャンが見ても理解できるように造っている。

っということで、わかりやすいソースコード=誰がみても理解できるコード

スキルアップ/キャリアアップ(JOB@IT)