使用 appleDoc 和 ///TODO: 注释

Question

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

///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 我的方法：]

显然我可以摆脱我的 TODO cmets，但我想将它们与我美丽的医生一起保留。有人知道如何实现吗？

Answer 1

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

您有 2 个解决方案：

1. 用/// @param myParam brief explanation of what it is添加另一行
2. 使用// 而不是///。