< コードレビュー > 反省・改善点

コードレビューを受けての反省・改善点のまとめ

コメントアウトについて

// コメントアウト

通常コメントアウトは上記のように行うと思いますが、
文字形式によっては上記のように行うと
正しくコメントアウトだと認識してもらえないことがあります。

UTF-8の場合、文字バイトが以下のようになっています。
1Byte : 1~9 , A~Z etc...
2Byte : 漢字 etc...
3Byte : "能" etc...

1.2Byteは問題ありませんが、3Byte文字の場合問題が発生する可能性があります。
この問題を解決・未然に防ぐ方法が、コメントアウトの最後に " . "を付けるということです。

// コメントアウト.

基本的にはあまり起きることはないかと思いますが、癖づけておくにこしたことはないと思います。

・コメントを書く場所について

コメントを書くのはなぜかというと、
・時間がたってからコードを見たときに素早く解釈できるようにするため。
・ほかの人が見たときに理解しやすいように。
が基本にあると思います。

だからといって、以下のようなコメントの付け方はあまりよろしくないです。

// データ格納変数
int data = 0;

// データを格納
if(data == 0)
{
 data = getData();
}

基本的に見ればわかるようなところにはコメントは書かない。
if文やfor文などになぜこのようにするのかと書くのが良い。

・変数/関数名について

所謂、命名規則というものです。

プロジェクトによっていろいろ決まっていると思いますので
その形に合わせて作るのが一般的です。

・関数の粒度について

関数を作成し処理を作っていくうちに、関数の中身が多機能化してしまう。
そして関数の粒度がばらばらになってしまい結果的に汚いソースコードになってしまいます。

基本的には、関数一つにつき処理は一つ。
ソースコードの長さとしては70ラインが目安です。

関数の中で処理を複数行う場合は、一つ一つを関数にし
関数内でif文・for文などを極力使わない。

これにより、コードがきれいになります。

・PublicとPrivateについて

オブジェクト指向としては関数内部で呼ぶものはPrivate、外から呼ぶものはPublic。

Publicの関数からPublicの関数を呼ぶというのは基本的にはおかしく
その場合は呼ぶ関数はPrivateのほうが正しい。

外部からも内部からも同一の関数呼ぶ場合は
関数をPrivateにし、外から呼ぶときにはPublicにその関数を呼ぶ関数を用意するというのが正しいことがある。