Q&A
英語自体は苦手ではないのですが、ドキュメンテーションの見方がやはり慣れません。
少しコツや良い解説などがあれば教えていただきたいのですが、例えば、今コードで
String(describing:hoge)というコードを見つけて、通常Int型のイニシャラーザーを使って、型を変換する場合はInt(hoge)なのにどういうことなのかと調べようとドキュメンテーションを引いてみようと思いましした。
Init(describing:hoge)に関するドキュメンテーション
Swift
1//documantation declaration 2//init<Subject>(describing instance: Subject) 3 4//documentation for example 5print(String(describing: p))
例えば、上記の様にdeclarationと具体例が書かれているのですが、どの様に読み取ればいいのかがわかりません。
個別的なドキュメンテーションの見方
1.initはイニシャライザーの呼び出しなので、実際の例では省略OKと解釈していますが、合っていますでしょうか？例えばPHPのドキュメンテーション上、省略していい箇所は[, omit]の様にカッコが気にされていたりするのですが、その様な物がないので、迷っています。
2.<Subject>この括弧書きとSubjectの意味は具体的にどういう意味なのでしょうか？実際の例を見るとStringという型（構造体）を指定している様に見えるのですが・・・
3.describing instance: SubjectここのinstanceとSubjectに相当する者は一体。。。実際にinstanceは特に具体例に何もないので省略されている？Subjectは結果的に変換したい値だとは思うのですが、init<Subject>とは同じ値を代入していない様に見えるのですが前半と後半のSubjectは文法説明上、意味が異なるのでしょうか？一般的には対象という意味なのかと思いますが。
###具体的なドキュメンテーションの見方
また、最終的にInt(hoge)となぜ文法的に違う（describing:を付すといういみで）ことをこのdocumentationから読み取ろうとしているのですが、一通り読んでも文字列を作成するためのinit<Subject>(describing instance: Subject)としか読み取れず、ここからだけではなぜInt(hoge)とは違うのかが読み取れなかったのですが、そもそもそういう違いを知るためにdocumentationを見るというアプローチが間違っているのでしょうか？※と言いつつInt()は構造体としての説明しかない（数値列への変換というイニシャライザー的な説明は内容にお見受けしました）ので比較してみるということもできてはいないのですが・・・
少し、最後に説明が下手になったしまい申し訳ございませんが、Int(hoge)とString(describing:hoge)の文法的な違い（イニシャライズの方法になぜ違いがあるのか）をdocumentation勉強したいというときに、アプローチ方法がわからなかったということでございます。
非常に基礎的なことで申し訳ございませんがよろしくお願い申し上げます。
回答1件
0
ベストアンサー
Swiftの仕様書の一読をお勧めします。
英語が苦でないなら、面倒でも一度全部読むのが最も効率のよい学習方法だと思います。
Webならswift.orgにあります。
iBookでダウンロードして読むこともできます。
いずれも無料ですし、英文も非常に読みやすく、よくできていると私は思います
A Swift Tourの部分だけでもかなり有用なので、ご一読ください。
1.initはイニシャライザーの呼び出しなので、実際の例では省略OKと解釈していますが、合っていますでしょうか？例えばPHPのドキュメンテーション上、省略していい箇所は[, omit]の様にカッコが気にされていたりするのですが、その様な物がないので、迷っています。
省略OKです。合っています。
let struct = MyStruct.init(param: a)
let struct = MyStruct(param: a)
let struct: MyStruct = .init(param: a)
これらはいずれも同じです。
たしかに[]をつけるような記載の仕方はみかけませんね。
2.<Subject>この括弧書きとSubjectの意味は具体的にどういう意味なのでしょうか？実際の例を見るとStringという型（構造体）を指定している様に見えるのですが・・・
ジェネリクスです。型をパラメータ化する手法で、Subjectとある部分は実際の型名のプレースホルダです。
例えば、Intのaという変数があるとして、String(describing: a)としたとき、Swiftは、aの型がIntであることから、String.init(describing instance: Int)の呼び出しだと理解してくれてそのように処理されます。
Stringの変数を渡したら、String.init(describing instance: String)の呼び出しとして処理されます。実際に全部の型のinitが個別に定義されているということではないのですが、そう思ってもいいような感じに使えるのがジェネリクスのすごい所です。
3.describing instance: SubjectここのinstanceとSubjectに相当する者は一体。。。実際にinstanceは特に具体例に何もないので省略されている？Subjectは結果的に変換したい値だとは思うのですが、init<Subject>とは同じ値を代入していない様に見えるのですが前半と後半のSubjectは文法説明上、意味が異なるのでしょうか？一般的には対象という意味なのかと思いますが。
describingは引数ラベル(argument label)です。
instanceはパラメータ名(parameter name)です。
引数ラベルはその関数を呼ぶ時に使う引数名で、パラメータ名は関数の実装時に使う引数名です。どちらも同じ引数を指します。
可読性を向上するため、同じ引数が二つの名前をもてるようになっています。
たとえば、
func move(to: CGPoint) { if to.x > 0 { 何かする() } }
このmove関数を使うときは、move(to: p)とすればよく、可読性に問題はありません。
しかし、実装側はtoを関数に渡された引数名として使うことになります。to.xは、to自体に点という意味がないため、一見して意味がわかりにくく、可読性に問題があります。
func move(point: CGPoint) { if point.x > 0 { 何かする() } }
この場合、実装は分かりやすくなりましたが、使う側はmove(point: p)としなければならなくて、move(to: p)より可読性が悪いです。
引数ラベルとパラメータ名を定義することで、この問題を回避できます。
func move(to point: CGPoint) { if point.x > 0 { 何かする() } }
引数ラベルをtoとし、パラメータ名をpointにしました。呼ぶ方はmove(to: p)として使えるので分かりやすく、move関数の内部ではpoint.xとして渡されたパラメータにアクセスできるので、可読性がよくなりました。
なお、引数ラベルを省略すると、パラメータ名が引数ラベルになります。
また、引数ラベルに_を指定すると、呼ぶ方はパラメータ名を省略して呼べるようになります。
Int(hoge)としたときに呼ばれるイニシャライザは、init<T>(_ source: T) where T : BinaryIntegerと定義されています。
Tがジェネリクスによる型名です。引数ラベルが_なので、引数名が不要です。（where以降はTがどんな型かを指定しています）
String(describing: hoge)は、引数にdescribingという引数ラベルをもつイニシャライザを呼べと指定しているので、String.init<Subject>(describing instance: Subject)が呼ばれています。
文法的には、単に引数ラベルの定義の違いです。
これらはSwiftの仕様のFunctionsで説明されています。
投稿2020/09/14 08:42
総合スコア803
あなたの回答
tips
プレビュー
バッドをするには、ログインかつ
こちらの条件を満たす必要があります。
2020/09/14 13:42
2020/09/14 13:53
2020/09/15 00:05 編集
2020/09/15 00:45 編集
2020/09/15 02:52
2020/09/15 02:56