コードの書き方とTips - enpitut2019/dj-yusaku GitHub Wiki

• コードの意図が伝わるようにしよう
  • まともな変数・クラス・関数名があれば一目でその処理がわかるはず
  • ある変数の意味をコメントで説明する必要があれば、その変数名が良くないかもしれない
  • マジックナンバー（変化しない数値や文字列）は定数として定義しよう
  • 変数の命名にヒントになるサイト： Codic
• 視覚的にその構造が分かりやすいコードを書こう
  • コードゴルフのようなコードを書くのはやめよう
• 再利用性の高いコードを書こう
  • 同じような処理があるときはコピペをせずに関数化しよう
  • コードのシルエットが似ているときは関数化できるチャンスだと考えよう
• 一度に一つの処理をするようにしよう
  • 計算結果を一旦変数に代入したり、処理を複数の関数に分けるなど、コードを分割しよう

ブランチ名は作業単位で区切りましょう。
作業名には、feature(新機能), update(既存のものの見た目の更新), fix(既存のもののバグ修正) をつけましょう。

# 新機能
feature/<作業名>
# バグ修正
fix/<作業名>
# 見た目の更新
update/<作業名>

# 例 （新機能 some-good-feature を追加したとき）
feature/some-good-feature

短く簡潔な日本語で書きましょう。他の人に作業内容がわかるようにしましょう。
コミットメッセージが長文になるような場合には、作業配分が誤っているかもしれません。

delegateやprotocolの実装はextensionで書きましょう。

class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        /* ... */
    }
}

// MARK: - UITableViewDelegate

extension ViewController: UITableViewDelegate {
    /* TODO: 未実装 */
}

コメントに MARK: /TODO: /FIXME: 　などを記述すると、Xcodeがハイライトしてくれるので、delegateの実装箇所や未実装部分などのメモに使いましょう。