読者です 読者をやめる 読者になる 読者になる

からたちねみち

歌を作っています。Vocaloid、主に結月ゆかり、またはiPhoneアプリ開発

コメントとは コメントの書き方

iPhoneアプリ開発

Swiftでのコメントの書き方を覚えましょう。

 

目次

  • コメントとは
  • 書き方

 

コメントとは

プログラムの中に書く注釈・メモのようなものです。

 

プログラムを後で見返したときや、第三者が見たときに内容をわかりやすく伝えるために、書きます。

例えば下記のようなコードを目にしたとします。

f:id:bettychang:20160115231843p:plain

 

目にしたのがこのプログラムを書いてから数日程度であれば、このコードの内容、目的を覚えているかもしれませんが、それが2ヶ月後だったらどうでしょうか。

私なら確実に何も覚えていません。そして、このコードの意味するところはなんなのか、この変数にはなにが入っていて、なんで足し算しているのか?などなどいろいろと調べだすことでしょう。

 

 

では、こちらならどうでしょう。

f:id:bettychang:20160115232412p:plain

 

とりあえず、下記のことくらいは、ぱっと見てすぐに把握できます。

  • 終了するときの処理をここにまとめているらしい
  • 終了のための条件が2つ描いてあるようだ
  • ゲームの終了フラグをセットしているらしい

 

この緑色の文字がコメントです。

最初のうちは、いちいち書くのがめんどくさく感じますが、書いておくと後でプログラムを見返すときにかなりの時間の節約になります

 

書き方や内容にはかなり個人差がありますが、別になにも決まりはありませんので、自分(または共同作業者)が後で見たときにわかりやすいことを意識して自由に記載しましょう。

 

書き方

スラッシュを2つ書き、そのあとにコメント内容を書きます。

//コメント

 

そうすると、スラッシュ以降の文はXcodeからは無視されます。

 

行をまたがる書き方もできます。その場合は、スラッシュ+アスタリスクで始めて、アスタリスク+スラッシュで終了します。

/*

コメントです。

*/

 

以上です。

ご覧いただきありがとうございました!

 

swift-bettychang.hatenadiary.jp