使用HeaderDoc或Doxygen时是否可以包含代码示例?

时间:2011-01-02 13:28:01

标签: objective-c doxygen documentation-generation

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

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

使用Apple的HeaderDoc工具时是否可以,如果是这样,它将如何完成?

如果不可能,在使用Doxygen时我该怎么做?

2 个答案:

答案 0 :(得分:4)

对于那些使用苹果已安装工具“headerdoc”的人来说,它看起来像这样:

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

答案 1 :(得分:2)

好的 - 我有答案!我选择了Doxygen:

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