【问题标题】:Xcode documentation comment syntaxXcode 文档注释语法
【发布时间】:2015-02-02 07:25:00
【问题描述】:

我想知道是否有人可以解释 Xcode 中以下两种注释语法之间的区别/是否有任何区别。

/**
 * comments
 */

/*!
 * comments
 */

似乎两者都允许 Xcode 将您的 cmets 显示为文档,但我不确定两者之间是否有区别。

【问题讨论】:

  • 两者之间是否存在差异很重要

标签: xcode headerdoc


【解决方案1】:

它们在功能上是等效的。 /*!HeaderDoc 风格的开瓶器,/**JavaDoc 风格的开瓶器,doxygen 常用。 Xcode 5 支持 HeaderDoc 和 doxygen/JavaDoc 格式。

【讨论】:

    【解决方案2】:

    两者在功能上是等效的。

    区别:

    /**

    1. Doxygen 风格
    2. 如果您使用headerdoc2html 命令,基于/** 的cmets 将不会出现在文档文件中,它将跳过这些cmets(请参阅HeaderDoc not generating HTML Documentation

    /*!

    1. HeaderDoc 样式
    2. 如果您使用headerdoc2html 命令,/*! cmets 将以 HTML 格式显示在文档文件中,这与 /** 不同

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2011-09-30
      • 2010-10-02
      • 2014-10-30
      • 2010-11-01
      • 2012-01-09
      • 1970-01-01
      相关资源
      最近更新 更多