xcode 使用appleDoc和///TODO:评论

baubqpgj  于 2023-04-13  发布在  其他
关注(0)|答案(1)|浏览(163)

我正在做一个使用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注解,但我想把它们和我漂亮的文档沿着保留下来。有人知道如何做到这一点吗?

chhqkbe1

chhqkbe11#

当你添加一个///块时,你触发了一个Appledoc/Doxygen文档块,并且该函数被标记为已记录。文档生成器将检查并报告该块不完整,因为你没有记录该参数。
您有两种解决方案:
1.用/// @param myParam brief explanation of what it is添加另一行
1.使用//代替///

相关问题