使用 HeaderDoc 或 Doxygen 时是否可以包含代码示例?
我正在用 Objective-C 编写一个 Cocoa 框架,并希望使用文档编写器来生成 API 参考。对于 .NET,很容易包含以下示例:
/// <example>
/// <code lang="c#">
/// Console.WriteLine("Hello, World!");
/// </code>
/// </example>
使用 Apple 的 HeaderDoc 工具时是否可以这样做?如果可以,将如何完成?
如果不可能,使用 Doxygen 时我该怎么做?
I am writing a Cocoa framework in Objective-C and would like to use a documentation writer to generate the API reference. For .NET, it is easy to include examples using:
/// <example>
/// <code lang="c#">
/// Console.WriteLine("Hello, World!");
/// </code>
/// </example>
Is this possible when using Apple's HeaderDoc tool, and if so, how would it be done?
If it is not possible, how would I do it when using Doxygen?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(2)
对于那些使用苹果已经安装的工具“headerdoc”的人来说,它看起来像这样:
For those who go with Apples already installed tool "headerdoc", it can look like this:
好的 - 我已经得到答案了!我选择使用 Doxygen:
Okay - I've got the answers! I've chosen to go with Doxygen: