Xcode : メソッドリストにコメントを表示

iOS 開発 Tagged with: Tips, Xcode

2月 192010

最近、Xcodeのメソッドリストにソース内のコメントを表示できることを知った。もちろん、リストからそのコメントを選択すれば、コメントが書かれている箇所まで飛んでいく。非常に便利である。

ファイル内に記述されているすべてのメソッドを一覧表示してくれるのがメソッドリスト。ここを選択するか、Ctrl-2で表示できる。
Xcode メソッドリスト

このリスト内に、コメントの一部を表示することができるのだ。
例えば、以下のリスト内にある、

TODO: Alert message should be shown to user.
FIXME: These four delegate methods have crash problem.
???: This operation may have problem when frcSectionCount is larger than tableSectionCount.

これらはすべて、コード内にコメントとして記述したものだ。

Xcode メソッドリストに表示されるコメント

記述方法は、このように、// TODO: や // FIXME: という特定のキーワードで始めればよい。

Xcode メソッドリストに表示可能なコメント

利用可能なキーワードは、

の5つ。

ただし、// MARK: は、#pragma mark と同等の機能であり、メソッドリストには、MARK: というキーワード自体は表示されない（他のキーワードは表示される）。

もう一点注意点としては、キーワードとコロン(:)の間にスペースがあってはいけないらしい。

メソッドリストに表示されたコメントを選択すれば、コメントを挿入した箇所まで飛んでいく。とても便利。あとで実装しようと思ったことなどをTODO: コメントで書いておけば、ソースの中からその場所を探す手間も省ける。

プロジェクトの規模が大きくなってきたり、ソースが長くなってきた場合、この機能を使うことで、手間と時間を節約できるのではないだろうか。

最初にこの件を教えてくれた、@malted_milk さんに感謝。
詳細は、More iPhone 3 Development: Tackling iPhone SDK 3 (Beginning) にも載っています (p.74) 。

posted with amazlet at 11.03.31

Dave Mark Jeff Lamarche
Apress
売り上げランキング: 29207