headerdoc : @see tag

閱讀本文前，請先安裝蘋果的headerdoc

像是Javadoc、asdoc等都會有@see tag，雖然我只有用過javadoc，但我記得@see tag不是很麻煩（至少沒有headerdoc麻煩。）。

在headerdoc中，假設要建立一個像下面這樣的@see 連結

一樣是要這麼寫：
/*!
* 解說文字
@see removeObjectAtIndex
*/
-(void)removeLastObject;


但是呢，這樣子是沒效果的。
根據HeaderDoc User Guide: HeaderDoc Tags的建議，你的@see tag應該要這麼寫：
/*!
* 解說文字
@see myOtherFunction
*/
-(void)myFunction;

或者是
/*!
* 解說文字
@see //apple_ref/c/func/myOtherFunction
*/
-(void)myFunction;


但是上面兩者無論哪個都是沒・用・的！
為什麼呢？觀看一下headerdoc產生的文件就能知道了。
假設我想要連結下面的的function addObject

雖然我的function的title是這樣的：
<h3>
<a name="addObject:">addObject</a>
</h3>
但是，headerdoc要的是紅框裡的連結，也就是//apple_ref/occ/instm/List/addObject:

所以我的headerdoc應該像這樣：

/*!
* 解說文字
@see (從上面找到的那個連結)
*/
-(void)myFunction;


順帶一提，懶得找的話也可以從method那裡找到（因為method的連結全都是那樣的格式）

但是別忘記去掉#號。