2014-03-19 45 views
2

我是相當新的Doxygen的,而我試圖找出如何做到代碼片段的例子,如下所示:Doxygen的C#代碼片段的例子

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

如果我沒有記錯,這是如何文檔解釋瞭如何做這樣的事情:

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

不工作100%,至少對我來說。我找到了如何與其他語言做到這一點,但不是C#的例子。

我得到的是示例選項卡,該頁面顯示了我用作示例的文件,甚至可以單擊「\ Example SomeFile.cs」提供的鏈接。除了頁面上沒有代碼,只是我提供的額外細節。

有沒有人有與doxygen能夠生成頁面(如在第一個鏈接)與C#的任何經驗?

謝謝大家。

回答

1

如果有人想在將來這樣做,並且似乎無法找到如何做到這一點,請將其更換。

使用Doxygen GUI。轉到專家標籤。在主題下選擇輸入。向下滑動到EXAMPLE_PATH。找到包含您的示例的文件。我傾向於在單獨的文件中分離我的測試,所以這適用於我。

1

我知道這有點舊,但是這個問題出現在搜索的頂部,看起來並沒有答案。認爲這可能會幫助別人。

您可以使用@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; 
}