首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >使用appleDoc和//TODO:注释

使用appleDoc和//TODO:注释
EN

Stack Overflow用户
提问于 2014-07-24 13:47:11
回答 1查看 168关注 0票数 0

我正在从事一个使用AppleDoc生成文档的项目。我想在代码中添加一些TODO注释,例如:

代码语言:javascript
复制
///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评论,但我想保持他们与我美丽的医生。有人知道如何做到这一点吗?

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2014-07-24 13:52:16

添加///块时,会触发Appledoc/D氧气文档块,该函数被标记为文档化。文档生成器将检查并报告该块不完整,因为您没有记录该参数。

你有两个解决方案:

  1. 使用/// @param myParam brief explanation of what it is添加另一行
  2. 使用//而不是///
票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/24935546

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档