HeaderDocを使ってコメント内にソースコード片を記述する方法がAppleのドキュメントには載っていなかったので、メモとして残しておきます。
コメント内にコードを記述するには、@codeと@endcodeとを使います。
/**
コード片をコメントに書くには\@codeと\@endcodeで区切って記述します。
@code
BOOL result = [myObject foo];
@endcode
*/
- (BOOL)foo;
:
この２つに囲まれた範囲がソースコードとして認識され、バルーンヘルプにもそれらしく表示されるようになります。
参考サイト
stackoverflowの以下の記事が参考になります。