我正在从事一个使用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:对-MyClass myMethod缺少的参数“myParam”的描述:
显然,我可以摆脱我的TODO评论,但我想保持他们与我美丽的医生。有人知道如何做到这一点吗?
发布于 2014-07-24 13:52:16
添加///块时,会触发Appledoc/D氧气文档块,该函数被标记为文档化。文档生成器将检查并报告该块不完整,因为您没有记录该参数。
你有两个解决方案:
/// @param myParam brief explanation of what it is添加另一行//而不是///。https://stackoverflow.com/questions/24935546
复制相似问题