使用appleDoc和/// TODO：评论

Question

我正在开发一个使用AppleDoc生成文档的项目。我想在我的代码中添加一些TODO注释，例如：

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

问题在于，当我尝试生成项目文档时，我会收到麻烦的警告：

  

/Users/Me/trunk/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. 使用//代替///。