Question

我是doxygen的新手，我正在试图弄清楚如何编写代码片段示例，如下所示：

http://www.doxygen.nl/manual/examples/example/html/example_test_8cpp-example.html

如果我没有弄错的话，这就是文档解释如何做这些事情的方式：

http://www.doxygen.nl/manual/commands.html#cmdexample

至少对我而言，这不起作用100％。我找到了如何使用其他语言执行此操作的示例，但不是c＃。

我得到的是示例选项卡，显示我正在使用的文件作为示例的页面，我甚至可以单击“\ example SomeFile.cs”提供的链接。除了页面上没有代码，只提供我提供的额外细节。

有没有人有过使用C＃生成页面（比如第一个链接）的经验？

Answer 1

如果有人想在将来这样做，并且似乎无法找到如何做到这一点。

使用Doxygen GUI。转到“专家”选项卡。选择主题下的输入。 Scoll下到EXAMPLE_PATH。找到包含您示例的文件。我倾向于将我的测试分成单独的文件，所以这对我有用。

Answer 2

我知道这有点旧，但是这个问题出现在搜索的顶部时，看起来并没有得到答案。认为这可能会帮助别人。

您可以在评论中使用@code和@endcode标签在doxygen中生成代码段：

像这样：

/// <summary>
/// This does something cool.
/// </summary>
/// <example>
/// Usage:
/// @code
///     var = GetValueOf(9f);
/// @endcode
/// </example>
/// <param name="_myParam">A float value to return</param>
public float GetValueOf(float _myParam)
{
   return _myParam;
}

Doxygen C＃代码片段示例生成

2 个答案: