protocol内の関数の認識があっているか確認してほしい

Question

下記のコードの認識の確認と2つ質問をさせていただきたいです。

protocol ProfileHeaderDelegate: class {
    func header(①_ profileHeader: ②ProfileHeader,③didTapActionButtonFor user: ④User)
}

確認してほしい認識
①引数
②型
③引数
④型

疑問
A ①の「＿」はどのような意味があるのでしょうか。

B 引数名にdidTapActionButtonFor userと2つの単語を用いているのは単に可読性を高めるためでしょうか。

Aに関してはリンク内容
上記の記事を参考にして「引数ラベルの省略」かなと思ったのですが、確信が持てなかったので質問させていただいてます。

ちなみにdelegateの呼び出し?は下記のようになっています。

delegate?.header(self, didTapActionButtonFor: viewModel.user)

Answer 1

確認事項

① _ が引数ラベルの省略、profileHeader が内部引数名
② 引数 profileHeader の型
③ didTapActionButtonFor が引数ラベル、user が内部引数名
④ 引数 user の型

引数ラベル名は「外部変数名」と呼ばれることもあるかもしれませんが、呼び出すときのコード（外部）に直接現れてくる引数名です。内部引数名は「内部変数」や「内部定数」と呼ばれることもありますが、こちらは実装するときのコード（内部）に直接現れてくる引数名になります。

質問 A

① は、お察しの通り、引数ラベル名の省略です。

Swift のメソッドでは、今回のように _ を付与しない限り、引数ラベル名を指定する必要が出てくるため、メソッドを呼び出す際に引数ラベルを指定しないようにしたいときには _ を引数名の前に付与します。

なお、今回の例でこの _ がなかったとすると、delegate の呼び出しは次のようになります。

delegate?.header(profileHeader: self, didTapActionButtonFor: viewModel.user)

質問 B

こちらもお察しの通り、単に可読性を高めるためと思ってもそう遠くないような気がします。

どこの可読性を高めるかといえば、引数ラベル didTapActionButtonFor は呼び出すときのコードの可読性を高め、内部引数 user はそのメソッドの処理を実装するときのコードの可読性を高めます。

---

たとえば今回の ProfileHeaderDelegate 型が持つ header メソッドが、今回の定義どおりになっていたとすると、その実装を例えば次のような感じで書くことができます。

func header(profileHeader: ProfileHeader,didTapActionButtonFor user: User) {
        
    let viewController = ProfileEditorViewController()
        
    viewController.username = user.name
    viewController.birthday = user.birthday
        
    present(viewController, animated: true, completion: nil)
}

そして、これを呼び出すときには、挙げられていたとおり、次のように呼び出せます。

delegate?.header(profileHeader: self, didTapActionButtonFor: viewModel.user)

ところが、これを外部引数名を使わなかったとき。つまり次のように ProfileHeaderDelegate が定義されていたとします。

protocol ProfileHeaderDelegate: class {

    func header(profileHeader: ProfileHeader, user: User)
}

こうすると、実装時のコードには影響ないですけれど、呼び出すときには引数名を次のように user として指定することになってきます。

delegate?.header(profileHeader: self, user: viewModel.user)

このように記載してもわからないことはない気はするのですけれど、この１行だけを読んだときに user という引数がどういう目的での user なのかが汲み取れないのと、この１行がどんな意味かが理解しにくくなってきます。

この引数名が、最初の例の通り didTapActionButtonFor として指定できるようになるだけで、この引数 user が「押されたアクションボタンに関連づけられているユーザー」であることがわかるようになってきます。

---

対して、外部引数名を別途指定せずに、引数名を didTapActionButtonFor にしたとします。こうすると今度は、それを呼び出すときには挙げられていた例の通りに記載できますけれど、実装のときにも変数名として didTapActionButtonFor を使うことになるため、次のようなコードに変わってきます。

func header(profileHeader: ProfileHeader, didTapActionButtonFor: User) {
        
    let viewController = ProfileEditorViewController()
        
    viewController.username = didTapActionButtonFor.name
    viewController.birthday = didTapActionButtonFor.birthday
        
    present(viewController, animated: true, completion: nil)
}

こちらの場合は、コードの可読性低下が顕著に現れてきて、たとえば viewController.username = didTapActionButtonFor.name と書かれているのをみて、それが意味するものがわかりにくいし、適切ではない印象がします。素直に読んでみて「名前のためのアクションボタンが押されたのを viewController の username に代入」する？というのもよくわからない気がします。

これが例として挙げられていた通りの元の表記であれば、次のようになっていました。

func header(profileHeader: ProfileHeader,didTapActionButtonFor user: User) {
        
    let viewController = ProfileEditorViewController()
        
    viewController.username = user.name
    viewController.birthday = user.birthday
        
    present(viewController, animated: true, completion: nil)
}

メソッド定義の冒頭で、引数 user が didTapActionButtonFor のもの、つまり「このユーザーについてのアクションボタンが押された」と説明されているので、この user がどのようなものかをこの時点で把握できます。

それがわかればあとは普通に、例えば viewController.username = user.name と書かれているコードを読んでも、それが「アクションボタンに関連づけられていたユーザーの名前を viewController の username に代入する」というように、難なく読むことが可能になっていると思います。

---

このように「その１行のコードが英語的に自然に読めるようにする」ことは、Swift 公式の API デザインガイドラインでも推奨されているのもあって、今回のように外側から見える外部引数名と内部で使う（内部）引数名とを意識的に分けて使うことはよくあります。

Comments

[momokoko]

回答ありがとうございます。
今、頭が回っていないのでまた後日時間があるときにゆっくり読ませて頂きます。

[momokoko]

すみません、お返事遅くなりました。
本日ゆっくり読めそうなので本日中に返答させていただきます。

Answer 2

たしか Swift 実践入門をお持ちだと思いますが、関数の章の引数、特に外部引数名と内部引数名あたりをお読みください。① の _ および ③ の didTapActionButtonFor が外部引数名、① の profileHeader および ③ の user が内部引数名です。また、外部引数名が _ の場合は引数ラベルが省略されます。

Comments

[momokoko]

ぼくに合わせて回答感謝いたします！
読んでみます！