見やすいソースって・・・

質問

こんにちは、tomokooです。
Javaで開発してるのですが、見やすいソースってどんなのだと思いますか？
・各メソッドの頭に、メソッドの説明や引数の記述がある
・数字定数がソースコード中にない
・if文はどんなに短くても“{}”でくくる
・・・・
等、色々あると思うのですが。
人のソースを見たとき、見やすいな～。と思うことがあったら、どんなことでもいいので教えてください。
コーディング規約の原本を水曜までにまとめなくてはいけません。
よろしくお願いします！

回答No.1

Mizyu · ベストアンサー

Javaに限ったことではないですが今まで見てきたソースで下記が守られているものはとても見やすく感じます。

・変数、関数の命名規約がしっかりしており、似た変数、関数が無い。
・途中のコメントが適度に多く記載されている。
　（無駄に多いのは×）
　～を～している、というような明快な記載で書く。

この二つでかなり変わります。
というか、これらがきちんとしていれば「見やすいソース」にはなります。

あと、余談になりますが、、、
> ・if文はどんなに短くても“{}”でくくる
これは場合によるので規約には入れないほうがよいです。
くくらないほうがわかりやすい場合もありますから。

お礼

Mizyuさん、ありがとうございます！
if文は“{}”でくくる。と言うのは状況によってはよくないのですね？
初めて知りました。
命名規約、今までなかったので考えたいと思います。
ありがとうございました♪

回答No.2

BlueRay

大体のことはかかれているようなので、不足分として。
当たり前かと思いますがインデントは必要だと思います。
なかには、インデントすらしない人も居ますから。

後は、参考に以下のサイトは如何でしょう。
何かの役に立つかもしれません。

参考URL：

http://www.hym.ic.kanagawa-it.ac.jp/OB/1998/masuoka/system_note/CodingRule.htm

お礼

BlueRayさん、ありがとうございます！
こんなサイトがあったとは。。。
他にもあるのか！？と思って検索したら結構出てきました。。。
質問する前に調べるべきだった。

どうもありがとうございました！