2015年2月12日木曜日

お前のコードは余裕が無い

数日前に、上司に言われた一言

「お前のコードは余裕が無い」

今更ながらの、この言葉。
内容としては、ロジック云々ではなく、コーディングの書式の問題とのこと。

小さい会社ということもあり、また、別会社との協力なども無いため、この点は個人の裁量に任されているわけですが、レビューの際に混みいったロジックがあるときに、言われたわけです。

難しいことでななく、例えば

...
- (void)hogehoge {
    ....
    if (a != nil) {
       ...
    }
}
...

と、なっているが詰まっていると。
よって、

...
- (void)hogehoge
{

    ....
    if (a != nil)
    {

       ...

    }
    ...
}
...

こうした方が処理が、見た目にハッキリするだろう。
ってことでした。

確かに、、、
この際なので、Objective-C のコーディング規約を見ると、、、

Cocoa向け コーディングガイドライン - Apple Developer
https://developer.apple.com/jp/documentation/CodingGuidelines.pdf

メソッド名や、制御構文の横に「{」が。。。
そういえば、storyboard からの Action 貼り付けでは、この形だなと。

結局、いままで通りで行こうかと思ったけど、空白を使ってブロックを明確にする点と、メソッドのブロックは、改行することにしました。

些細な事ですが、開発が一段落ついたあとに、修正などがあった場合の可読性に関わってくるので結構重要ですね。

あと、コメントも同様。
わかりやすいメソッド名をつけていても、やはりパッと見での判断に差がでてくるので(適当な英語力で作ったメソッド名っていうこともある)、適切なコメントをつけることを心がけるようにしたいかと思います(言い訳がましいコメントをつけるのは論外ですが)。

新人の頃の内容なのに、おっさんになっても言われたので、戒めのために。。。

Written with StackEdit.

0 件のコメント:

コメントを投稿