【问题标题】:Doxygen /// comments at end of lineDoxygen /// 行尾注释
【发布时间】:2023-03-27 11:19:02
【问题描述】:

当我评论 cvars 时,我倾向于使用以下格式,因为我认为它更易于阅读。

UILabel *titleLabel; // The title label in the view

我当前的客户使用 doxygen,因此我将返回并将我的 cmets 转换为 doxygen 格式,我希望它会像

一样简单
UILabel *titleLabel; /// The title label in the view

不幸的是,这会导致注释被附加到下一个 cvar。

有什么方法可以告诉 doxygen 单行 cmets 应该属于他们所在行的 cvar 吗?

【问题讨论】:

  • 据称是的,但我一直无法让它工作。我会和你一样对这个问题的答案感兴趣。
  • Doxygen 有一本相当不错的在线和离线用户手册。如果你想使用 Doxygen,你应该至少阅读它的一些部分,比如“我如何放置内联文档”stack.nl/~dimitri/doxygen/docblocks.html

标签: objective-c documentation doxygen


【解决方案1】:

我认为您缺少<,请尝试使用:

UILabel *titleLabel; ///< The title label in the view

请参阅doxygen manual 了解更多信息。

【讨论】:

  • 谢谢!这将为我节省大量时间。
  • 在 Visual Studio 上,鼠标悬停时,会产生错误:“没有有效的 XML 注释,它包含一个空格”
猜你喜欢
  • 2011-09-04
  • 2019-02-13
  • 2012-02-28
  • 2012-09-01
  • 1970-01-01
  • 2012-11-06
  • 2011-09-05
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多