ios - 使用 appleDoc 和///TODO : comment

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: Description for parameter 'myParam' missing for -[MyClass myMethod:]

显然我可以删除我的 TODO 评论，但我想将它们与我漂亮的文档一起保留。有人知道如何实现吗？

Answer 1

当您添加一个/// block 时，您会触发一个Appledoc/Doxygen 文档 block 并且该函数被标记为已记录。文档生成器将检查该 block 并将其报告为不完整，因为您没有记录参数。

您有 2 个解决方案:

1. 添加另一行 ///@param myParam 简要说明它是什么
2. 使用//代替///。