他の人がメンテナンスをするという事を全く意識していないという事でしょう。
最低限以下のことが満たされないと落書きですね。
■可読性
・インデントをつける
きちんとネストさせる。
・適度に関数化されたコード
長すぎるルーチンは追いにくい。
但し、極端に1処理の中身が分散しすぎても読みづらい。
・1行が長くなりすぎる場合、適度に折り返す。
昔は70とか75文字とかで折り返してましたが、
今は画面が広いので、100文字ぐらいでも平気かな。
・ネストが深くなってきたら、関数化を。
条件判断をboolean型などの関数に追い出すことで
すっきりさせる。
■冗長の排除
・全く同じ処理はコピペで分散させない。
修正する場合全て修正する必要があり、修正漏れの危険がある。
・無駄な条件分岐を増やさない。
判定の順番をキチンと考えて無駄な判断をさせない。
■コメント
・用語・用字の統一
同じものを指すのに表現が統一されていないと検索しにくく、
また同一なのかの判断もつけにくい。
・ボックスコメント
ファイルの先頭部分にボックスコメントをつける。
関数などの先頭部分に機能の説明と引数、使い方などのコメント。
・中コメント
ある程度の単位の処理に中程度のボックスコメントをつける。
・コメント
特殊な処理や内容に説明が必要な場合、説明をつける。
・変数のコメント
用途や何を指すかの説明をつける。
『命名規約』等の『コーディング規約』等は別途作るとしても
この程度ができてないとソースを読む気にならないですね。
読みますけどね。
0 件のコメント:
コメントを投稿