[iOS] コメントの書き方 | プログラミング初心者向けObjective-C入門

2013/04/11

今回は型について説明するつもりだったのですが、その前にまだコメントについて説明してませんでした。

コメントとは

プログラム中に書けるメモです。
コメントを書くことによって、そのプログラムが何を表しているかを説明することができます。

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{

    @autoreleasepool {
        //1行コメントは行頭にスラッシュを2つ入れる
        
        //コメントの後は何を書いてもコンパイラに無視される
        
        //直前に書いたりできます
        NSLog(@"出力しちゃうよ");

        NSLog(@"Hello my comment!"); //こんな感じに後ろにつけてもOK
        
        //連続してコメントを買いてもOK
        //こんな感じに
        //なります
        
        /*
         毎回スラッシュをかかなくても、
         こんな感じに
         複数行にわたるコメントを
         書くやり方もあります。
         */

         /* このタイプでも1行にできます */
    }
    return 0;
}


コメントの書き方は2種類あって、

//(スラッシュ2回)
/* (スラッシュ+アスタリスク) からはじまり */(アスタリスク+スラッシュ)

で終わるものがあります。
どちらの書き方でも問題ないです。

Xcodeでのショートカットも用意されていて、マウスなどで文章を選択してから
Command + /
を押すと、

・コメントアウト(プログラムをコメントにしてしまう)
・コメントアウトを戻す

を切り替えることができます。

コメントの書き方がわかったところで、どんなコメントを書くのでしょうか?
プログラムに慣れないうちは、それこそ1行ずつ「ここは○○してる」なんて書くのもよいでしょう。
ただ、プログラムにある程度慣れてくると、プログラムを見返すときに大量のコメントはかえって邪魔になってきます。
なので、ぱっと見て、わかりづらい部分に添えるぐらいでよいかもしれません。

コメントの付け方には、いろいろな考え方や目的があります。
個人やチーム、プロジェクトごとに書き方を決めたり、書籍やオープンソースのプログラムを見るなどして、どんなときにどんな書き方がよいかを研究してみるのもよいと思います。

プログラムが載っていたら

さて、コメントについて説明したところで、これから次の説明に入るのですが、毎回プログラムを全文載せていく必要もないので、今後はこんな感じにします。

もしこんな感じに書かれてたら

NSLog(@"出力しちゃうよ");

実際のファイルでは、@autoreleasepool { とそれに対応する } までの間に書かれていると思ってください。

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{

    @autoreleasepool {
        //この中に書きます

        NSLog(@"出力しちゃうよ");

        //ここまで
    }
    return 0;
}

まとめ

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

次回こそ型と変数について書きます。

前回の課題の回答例

前回の課題の回答例です。
実際には上に書いたように@autoreleasepoolの間に書きます。

1) NSLogを使って、自分の名前を出力するプログラムを作りましょう

        NSLog(@"Kinkuma Taro");

2) NSLogを5回使って、1から5までの数値を順番に出力するプログラムを作りましょう

        NSLog(@"1");
        NSLog(@"2");
        NSLog(@"3");
        NSLog(@"4");
        NSLog(@"5");

自作iPhoneアプリ 好評発売中!
フォルメモ - シンプルなフォルダつきメモ帳
ジッピー電卓 - 消費税や割引もサクサク計算!

ページトップへ戻る