- PR -

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

1|2|3|4 次のページへ»
投稿者投稿内容
るぱん
ぬし
会議室デビュー日: 2003/08/01
投稿数: 1370
投稿日時: 2004-04-27 14:28
るぱんです。

「わかりやすい物を作れ！」
上司とかに言われませんか？

確かに言いたい事はわかるんですが、
じゃぁ、具体的にどんなものよ？
って考えてしまいます。

そこで、逆説的に、自分がメンテナンスするとしたら、こういうのが読みやすい！
と言うような物有りますでしょうか？

それを話題にしたいです。
宜しくお願いします。（＾＾

僕の考えでは「簡単な規約で統一されている。」
と言うのが今の現場に欲しいです。（汗）

皆さんはいかがですか？
七味唐辛子
ぬし
会議室デビュー日: 2001/12/25
投稿数: 660
投稿日時: 2004-04-27 14:37
同じようなやり方で構築されている。
ネーミングが適切である
ファンクション。プロシージャーのきりわけが、適切である
変数のスコープが適切である。　
共通の処理は共通処理に置かれていてネーミングが適切である
if else 等がタブで見た目に判りやすい
単純な処理の組み合わせでプログラムが構築されている。
タラン
大ベテラン
会議室デビュー日: 2004/03/17
投稿数: 138
投稿日時: 2004-04-27 15:16
確かに解りやすくソースを書くべきですね。

ある会社でのことですが

上司からこのファイルをこういう機能を追加してくれって言われて
ファイルを渡してもらったんですが
一瞬「はあ！」って感じでした。

ファイル名：「testAAA.java」　
いったいこのファイルはテスト用なのか本番用なのか？
javaファイルって大文字でクラス名が始まるのではなかったっけ？
それはいいとしてファイルの中身をみて呆れました。

if、elseのタブなし　勝手に作成
falseの場合のreturnなしで通る。。
変数はa1、a2．。。
変数のスコープは考えずに思いついたところに宣言。
Method名をみても何してるMethodなのが想像もできない
誰がいつ、なんのため作成したファイルなのがも知るよしもない。

いったい何考えている人なんだろうと思いました。




[ メッセージ編集済み 編集者: 未記入 編集日時 2004-04-27 16:36 ]
taku
ぬし
会議室デビュー日: 2002/11/12
投稿数: 918
お住まい・勤務地: 墨田区→中野区
投稿日時: 2004-04-27 15:25
コメントが無くても何をしているのか解る。
NAL-6295
ぬし
会議室デビュー日: 2003/01/26
投稿数: 966
お住まい・勤務地: 東京
投稿日時: 2004-04-27 15:48
引用:

takuさんの書き込み (2004-04-27 15:25) より:
コメントが無くても何をしているのか解る。


NAL-6295です。

その発言に、凄く同意します。
はゆる
ぬし
会議室デビュー日: 2004/02/16
投稿数: 1008
お住まい・勤務地: 首都圏をウロウロと
投稿日時: 2004-04-27 15:53
こんにちは〜。

引用:

takuさんの書き込み (2004-04-27 15:25) より:

コメントが無くても何をしているのか解る。

わー究極の回答っ！（笑）
でも確かに、”わかりやすい” というと 「コメントを付ける」 がセットに語られたりしますけど、本当に分かりやすいソースって、コメントがなくても追いやすいものですものね。(^^;
もちろん、七味唐辛子さんのおっしゃることがあってのことですが。
# あ、また他力本願になってしまった…

[ メッセージ編集済み 編集者: はゆる 編集日時 2004-04-27 15:54 ]
るぱん
ぬし
会議室デビュー日: 2003/08/01
投稿数: 1370
投稿日時: 2004-04-27 16:02
コメントをつけなくても中で何をしているかがわかる事って、一つの理想ですね。

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

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

−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−

ここからはテーマは二本立てになります。
１．「自分がメンテナンスするとしたら、こういうのが読みやすい！ 」
２．「コメントをつけないで済むソースコード」とはどんなソースコードか？
K
大ベテラン
会議室デビュー日: 2004/04/07
投稿数: 174
投稿日時: 2004-04-27 16:19
はじめまして。
引用:

ここからはテーマは二本立てになります。
１．「自分がメンテナンスするとしたら、こういうのが読みやすい！ 」
２．「コメントをつけないで済むソースコード」とはどんなソースコードか？

自分はJava使いなのでJavaのみの話になってしまいますが、
1についてはちゃんとオブジェクト指向で設計されているってことですかね。
適切にデザインパターンを適用してくれているとさらにありがたいです。
こういうコードの場合はソースコードからCASEツールでリバースエンジニアリングして
きれいなクラス図が生成できるので非常に見通しがよいです。
（現実はそういうことのほうが少ないですが）

2については適切な粒度にメソッドが分割されていて、メソッド名から何をやっている
のかがわかればコメントは最小限でいいと思います。
JavaDocコメントはできればほしいですが。
1|2|3|4 次のページへ»

スキルアップ／キャリアアップ（JOB@IT）