バグ の日記

憂鬱だ

パーマリンク by バグ on 2010年10月18日(月) 09:23

ソースコードって、分かりやすいのが一番だと思うんだ。

変数名は見ただけで何に使っているのか理解できたら最高だけど、何に使うのか説明するコメントを入れておけば、あとから見ても分りやすいじゃない?

まぁ、変数だけやなく関数や構造体、クラスにも同じ事が言えるよね。

結局何が言いたいのかというと、「仕様書が残っていない」、「コメントが全く書かれていない」他社の人間が書いたソースを解析&改造するのは非常に無駄な時間を過ごしている気分にさせられるので勘弁してほしいという事なんですよ(苦笑)

コメント

Re: 憂鬱だ

パーマリンク by 山崎 on 2010年10月18日(月) 09:30

おはようございます。山崎です。掲示板の方ではお世話になっております。

私も今、他人のソースコードを読む作業に悪戦苦闘しています。先生の昔書いた研究に使うコードを読んでいるのですが、「pp」とか「p1」とか「nc」とか、パッと見でわからない変数名が多くて大変です。^^; あまりにわかりにくかったため、自分で0からコードを書きなおすという不毛な作業をしています。

私も以来、他人(時間が経った後の自分も含め)がコードを読んだ時もわかるように、コメントをつけるように努力しています。

それでは、失礼します~。

Re: 憂鬱だ

パーマリンク by Dixq (管理人) on 2010年10月18日(月) 18:47

バグさんはあらゆる酷い現場を知っていそうだw

私は一時期可能な限り意味が解るようにを意識していたんですが、段々関数名が長くなってしまうんですよね。
例えば

CreateVideoStreamManager()

とかパっと見もうちょっと短くならんのかって感じですよね。
で、最近フォーカスの事をfccと書いているコードを見てみたんですが、コード検索するとみんなフォーカスのことはfccと書いている。
単語を略しすぎると解りにくくなるけど、
一般的に使われている略し方を知れば解りやすく短くすることも可能なんだなと思いました。

そして、うちには尊敬するSさんがいらっしゃるのですが、
その人のコードはスーパー美しい代わりにコメントが一切ありませんw

美しくも難解な計算式が出てくると泣けます(涙

Re: 憂鬱だ

パーマリンク by バグ on 2010年10月18日(月) 18:49

ソースコードに限らず、なんでも分りやすい事にこした事はありませんよ。
かくいう私も1つの案件を終えるたびに反省しまくってますし、半年後とかにソースを見て穴があったら入りたい気分になってばかりです(^_^;)