はじめてのコード整理チェックリスト

はじめに

コードレビューをもらう前などにチェックしているリストです。
誰でもできます。
気づいたことがあれば更新する予定です。

超基礎編

・ selfを付ける

・空行、空白が統一されているか

・メソッド名や変数名がキャメルケースになっているか

// NG例
func appendname() {
    let Name = "なまえ"
}

// OK例
func appendName() {
    let name = "なまえ"
}

・不要な変数、処理、コメントがないか

• 定義したけど使わなかった変数
• 実は処理が通っていないメソッド
• メモ程度で書いていたコメントなど...

基礎編

・マークコメントを付ける

例)
  //MARK: - Action   　　　　//ここからはActionの処理を実装しますという意味

    @IBAction func numButton(_ sender: UIButton) {
        guard let num = numLabel.text else {
            return
        }
        guard let senderdNum = sender.titleLabel?.text else {
            return
        }
        numLabel.text = num + senderdNum
    }

マークコメントを付けると、選択したマークコメントに飛べます

・ドックコメントを付ける

    /// ボタンを押下した時の処理　　　　　　　//メソッドなどの処理説明を書く
    /// - Parameter sender: UIButton　　　　　
    @IBAction func numButton(_ sender: UIButton) {

        guard let num = numLabel.text else {
            return
        }
        guard let senderdNum = sender.titleLabel?.text else {
            return
        }
        numLabel.text = num + senderdNum
    }

ショートカットキー

ドッグコメント
command⌘ + option + /

・アクセス修飾子を付ける

知っているようで知らないSwift5のアクセス修飾子

・メソッドの命名をわかりやすくする(どんな処理をしているのか)

うまくメソッド名を付けるための参考情報

参考

知っているようで知らないSwift5のアクセス修飾子
うまくメソッド名を付けるための参考情報