綺麗な見た目のコードを書く
概要
設計では無く、コードの見た目の話です。(OOPの場合)
バイト先のコードやGitHubで見かけたコードの書き方を参考にしています。
各言語ごとに文化があると思うので全て共通では無いとは思いますのでご了承下さい。
綺麗なコードの学び方
リダーブルコードを読む
OSSを読む
英単語のバリエーションを増やす ( 難しい単語はあまり適さない )
簡単な英文法を理解する ( send to server 的な )
箇条書き
思いついたら追加していきます。
共通
カンマの後ろはスペースを開ける ( 例: func add(x: Int, y: Int) )
{ の前にスペースを開ける ( 例: if (true) { )
改行の場所を意識する (無駄な改行や長いコードに改行なしは駄目)
変数宣言同士に改行は必要ない ( 意味がある固まりがあれば一つ改行があっても良い )
変数宣言後は改行を入れる ( メソッドが2, 3行の場合は必要無いかも )
コメントを付ける時は // コメント のように最初にスペースを開ける
後で修正必須なコメントは // FIX: コメント
修正が必須ではないが修正必要なコメントは // TODO: コメント
長いコードはメソッドに切り出せないか考える
classの前にclassの説明コメントを付ける (自明であれば必要無いかもしれない)
ガード節を意識してネストを極力無くす ( Swiftには guard というキーワードがある )
デバッグコメント ( print(~) ) やコメントアウトは削除する
OOP特有
メソッド内では意味のある変数名を使う
短い英単語は省略しないほうが分かりやすい ( X: uid -> userId O: HyperTextMarkupLanguage -> HTML )
メソッドは振る舞いなので名前は 動詞 か 動詞 + 名詞 (showやsettingChatView等、必ずしもこうとは限らない)
外から呼び出されないメソッドには private を付ける (classがどんな振る舞いをするのか分かりやすい)
命名は難しいので、OSS等を読んで参考にすると良さそう
メンバ変数は少ないほうが良いのでなるべく使わない (状態管理しやすい)