使用appleDoc和/// TODO：評論

Question

我正在使用AppleDoc生成文檔的項目。我想在我的代碼如添加一些TODO註釋：

///TODO: Some stuff to be done 
-(void)myMethod:(id)myParam{ 
    [self doSomeFancyStuff]; 
} 

的問題是，當我試圖生成我的項目的文檔，我得到論文麻煩的警告：

/用戶/ ME /主幹/ MyProject的/ MyProject的/ src目錄/ MyClass.m：119： MyClass.m@119：描述爲參數 'myParam' 失蹤 - [MyClass的 myMethod的：]

很顯然，我可以擺脫我的TODO評論但是我我想保留他們與我美麗的文檔。有人知道如何實現這一目標嗎？

Answer 1

當您添加///塊時，您將觸發Appledoc/Doxygen文檔塊，並將該功能標記爲已記錄。文檔生成器將檢查並報告該塊不完整，因爲您沒有記錄該參數。

你有2個解決方案：

1. 添加其他行與/// @param myParam brief explanation of what it is
2. 使用//代替///。