XcodeによるSwiftプログラミング中級講座

コメントとドキュメンテーション

全334コースを10日間無料で

ぜひご覧ください。

無料で視聴する すべての加入プランを見る
または
クラスやメソッドにコメントを書いて、Quick Helpで表示する方法を紹介します。
講師:
08:04

字幕

このレッスンでは、クラスやメソッドに対してコメントを書く方法を紹介します。まずコメントを書く前にですね、クイックヘルプという機能を見ておきたいと思います。このインスペクタ領域を開いてそしてその上のところを見るとですね、クイックヘルプというのがこちらに出てきます。これ、ソースコードの編集をしている時にはここにこのクイックヘルプが出てくるんですがこのクイックヘルプを表示しておくことによって、例えば この String 型っていうのはどんな文字列だったかなということを確認したければ、それが Unicode stringvalue ですよと、Unicode の文字列ですよ というのをこうやって確認することができます。String と同じように、例えば何かしらint 型の変数がある、という時にこの int っていうのはどんな int だったかなと思ってみれば、64-bit のsigned integer ですよ、というのをこうやって確認できる。これがクイックヘルプと呼ばれるところです。で、例えば UIImage とかですね、Apple が用意してくれているクラスに対しては、これがどういうクラスなのか、ということが こうやって見ることができるんですが、じゃあこれが自分の作ったクラスであるとか、自分の作った構造体であるとか、自分の作った関数であるとか、そういった時にはどうかと いってみてみるとですね、例えば loadImageDataというのがここにありますけど、これはクイックヘルプして見てみると、loadImageData でBool をリターンしますよってこれだけの情報しか出てきません。 で、このクイックヘルプに表示することができる情報はですね簡単に追加することができます。どうやったら追加できるのか、というと、例えばこの関数に対して、この関数 loadImageData に対して新しくコメントをちょっと付けてみたいと思います。この上にですね、一番簡単な方法は/ を 3 つ書きます。そしてその後ろに「画像のデータを読み込みます。」このようにコメントを書いてやります。このように / 3 つでコメントを書いてやると、その下のところにですね、loadImageData もう一度選択するとこの「画像のデータを読み込みます。」という風にこの 今書いたばかりのコメントがこの Description のところに反映されます。ですので、例えばここに Photo という構造体がありますけど、これに対しても何か例えば Photo 構造体の中で「写真のデータを管理するための構造体です。」 とこのように入力しておけばですね、ここの Photo を選択するとこういう風に表示されます。今表示されましたね。同じようにれを使っているところから見ても、例えばこの Photo の配列を作っているところであるとか、あるいはこの Photo のためのnewPhoto というのを作っているところであるとか、これを見るとですね、これがどういう構造体なのかということがもう凄い分かりやすく表示できるようになっています。 そしてですね、これはもちろん列挙型などにも使うことができるので、例えば上のところですね/// と書いて「写真の向きを表す列挙型です。」このように書いて、そしてこれが「縦向きです。」「横向きです。」このように書いてやって、そしてこの Portrait とかLandscape とかを参照しているところでこうやって見てやるとですね、この PhotoType.Portraitのところ、こうやって Portrait を選択してやると、Description のところに縦向きです、とか 横向きです といったように、これがどういうものなのかということを分かりやすくこのクイックヘルプで見ることができます。で、クイックヘルプはこのようにしてインスペクタ領域を表示していても見ることができますし、インスペクタ領域が閉じてあったとしても、Option キーですね、Option キーを押しながらこのクラス名とかですね変数名とかのところにこうやて合わせてやることによって、こいつは何者ですか というのをこういう風にポップオーバーで表示することができます。なので、この PhotoType というのは写真の向きを表す列挙型ですよ と。 で、Portrait っていうのはじゃあ何といったら これは縦向きですよ といったことで、どういうプログラムがここに書いてあるのかというのを分かりやすく確認することができるようになっています。で、基本的にはこの 3 本でですね、/ 3 本でこのコメントをつけていく というのがものすごい分かりやすいんですが、関数に関してはですね、関数とかメソッドに関してはリターン値がどうなっているのかとか引数がどうなっているか ということもおそらく書きたいんじゃないかと思います。例えば、渡された引数を 2 倍するようなdoubleValue というメソッドがここにありますよ、と。勿論 やってきたこの value に対して2 倍した数値をリターンするだけのこういうものですけど、これに対してこの value という引数がどういう値かというのをメモっておきたければ、ここにですね、まず /**このように書きます。3 本の / を使わないのであれば、このように /** から */ までという形式でコメントを書くようにしてください。そうすると これが、「引数の値を 2 倍してリターンする関数です。」という風に書いた時に、これがですね、このクイックヘルプなどで確認することができるようになります。 ただしですね、これ今までにDoxygen とかのツールを使ったことがある人はもうこの書き方 ものすごい慣れていると思うんですが、Doxygen などと違って ここが! になっているとSwift の場合現在対応してくれませんので、ここが ** である必要があるということに注意してください。それから さらにこの 1 行目のですね、この全体の概要を書いているところから1 行空けて、そしてそこの下にこれが引数とかリターン値がどういう値であるか、ということを コメントを書いていきます。その時も Doxygen 用の、例えばパラメータがどうなっているか というのはこの @param value という風に書くんですが、「2 倍される数値」 そして「@return 2 倍した数値」、こんな感じで書くのがDoxygen の形式なんですが、この Swift の場合はですねこの param の前のところに:、そして param の後ろのところに:、これが Swift の形式の書き方です。同じように @return も前のところに: をつけて、そして return ではなくてreturns にして: をつける。 これが Swift のコメントの書き方になります。このようにして書いてやると、これをですね、 doubleValue がどうなっているかというのをOption キーを押しながら選択することによって、パラメータの中の value は2 倍される数値、そしてリターンされるのは 2 倍した数値という風にしっかりと機能分けしてこのコメントがですね、認識されているのが分かると思います。このレッスンでは、クラスやメソッドに対してコメントを書く方法を紹介しました。

XcodeによるSwiftプログラミング中級講座

このコースではSwiftのプログラミングに慣れてきた方を対象に、より効率的にXcodeを使い、プロジェクトを管理するためのさまざまなテクニックを紹介します。各レッスンではブレークポイントやプロファイラを使った便利なデバッグ方法や、条件に応じてコンパイル対象のコードを書き分けるやり方など実際のアプリ開発で使える実践的なテクニックを解説します。

3時間01分 (27 ビデオ)
現在、カスタマーレビューはありません…
 
ソフトウェア・トピック
価格: 2,990
発売日:2015年10月29日

このコースは、「オンデマンド」でご利用可能であり、ダウンロードすることもオンラインで見ることもできます。

ダウンロードすると、オフラインでコースを使用し、豊富なインターフェースをフルに活用できます。複数のデバイスを使用したり、 一度に全コースをダウンロードしたくない場合は、アカントにログインして、ストリーミング・ビデオとしてコースのレッスンを視聴してください。

ビデオトレーニングをお楽しみいただけますように! お問い合わせは、cs-jp@lynda.com宛までご連絡ください。