文章/答案/技术大牛

发布

社区首页 >问答首页 >在使用HeaderDoc或Doxygen时，是否可以包含代码示例？

问在使用HeaderDoc或Doxygen时，是否可以包含代码示例？
EN

Stack Overflow用户

提问于 2011-01-02 21:28:01

回答 2查看 907关注 0票数 0

我正在用Objective-C编写一个Cocoa框架，并希望使用文档编写器来生成API参考。对于.NET，很容易使用以下命令包含示例：

/// <example>
/// <code lang="c#">
/// Console.WriteLine("Hello, World!");
/// </code>
/// </example>

在使用苹果的HeaderDoc工具时，这是可能的吗?如果可能，将如何实现？

如果这是不可能的，我怎么做时，使用Doxygen？

doxygen

documentation-generation

objective-c

回答 2

Stack Overflow用户

回答已采纳

发布于 2011-01-06 05:13:04

好的--我有答案了！我选择了Doxygen：

/**
 \code
 NSLog(@"Hello, World!");
 \endcode
*/

票数 2

Stack Overflow用户

发布于 2011-08-18 18:20:06

对于那些使用苹果已经安装的工具"headerdoc“的人来说，它可能是这样的：

/*!
   <pre>
   @textblock
   - (void)foo {
      // bar
   }
   @/textblock
   </pre>
*/

票数 4

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/4578555

复制

相似问题

问在使用HeaderDoc或Doxygen时，是否可以包含代码示例？
EN

回答 2

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问在使用HeaderDoc或Doxygen时，是否可以包含代码示例？EN

回答 2

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问在使用HeaderDoc或Doxygen时，是否可以包含代码示例？
EN