2014年5月14日水曜日

Xcodeで便利になるコメントの書き方

プログラムを書くときに、ちゃんとコメントを入れていますか?
一人で書く場合は、案外適当だったりしますよね。
そのコメントの入れ方で実はXcode上で便利になることを知りました。


普通はこんな感じでコメントを書くと思います。

スラッシュ2つ『//』のコメント

---------------------------------
//コメントテスト用メソッド
- (void) commentTest1 {
    
    //変数コメント
    int commentVal = 0;
}
---------------------------------


それをこのように変えてみてください。

『/**』と『*/』の間に書くコメント

---------------------------------
/** コメントテスト用メソッド */
- (void) commentTest1 {
    
    /** 変数コメント */
    int commentVal = 0;
}
---------------------------------


そして、その関数を補完候補で見てみると…

このように、コメントがメソッドの説明として表示されます。


同じように、変数でもこの通り。


このコメントの入れ方はドキュメント出力するとき用だと思っていました。
実はXcodeの補完候補でも使われているんですねえ。
今まで知りませんでした。

簡単で地味に便利なので、コメントを入れる時はこのやり方にしてはいかがですか?


アルファベットをタップして英単語を作る知育系アプリはいかがですか?
「しりとり」や「文字数制限」などのステージが48もありますよ。



0 件のコメント:

コメントを投稿