WPF的Doxygen文檔

Question

我目前正在為C＃代碼創建文檔。 我已經做了很多普通的源代碼，並設置了doxygen來創建HTML。 最終，我到達了用WPF完成的UI，因此XAML和源代碼都是如此。 現在我的問題是，記錄這些文件的最佳方法是什么？ 注釋在XAML中是可能的，但由於不能嵌套而沒有用。 另外我也不知道Doxygen是否可以處理XAML文檔。 那么，所有內容都應該記錄在xaml.cs文件中嗎？

Answer 1

我找到了一個或多或少的好解決方案。 首先，您必須將文件擴展名添加到FILE_PATTERNS ，所以我是* .xaml。 Doxygen使用擴展名來確定要使用的解析器。 我想默認值為C。接下來，您將像這樣添加文檔：

<!-->
/** \file
* \brief A brief file description.
* 
* A more elaborated file description.
*/ -->

<！-和->是xaml文件的注釋部分。 當Doxygen解析文件時，它將刪除文檔而不添加文件。 這就是為什么有一個>愚弄Doxygen解析器已完成注釋的原因。 我知道這很丑陋，但最糟糕的是，我的描述在文檔中丟失了，但在文件中仍然可用。 因此，只要沒有更好的方法，我就會堅持下去。

Answer 2

文件級注釋工作正常。

我還在XAML文件中使用了類：

<!-->
/** \file 
* \brief Global resources via the nexus_client.Generic class.
* 
* All user configurable parameters defined here.
*/ -->
    <ResourceDictionary
    x:Class="nexus_client.Generic"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:core="clr-namespace:System;assembly=mscorlib"
    xmlns:local="clr-namespace:nexus_client">
    <!-->
    /** \class nexus_client.Generic
    * \brief Global resources via the nexus_client.Generic class.
    * 
    * All user configurable parameters defined here.
    */ -->

現在，我正在嘗試記錄屬性：

<!-->
/** \property nexus_client.Generic.OEBackgroundBrushBuy
* \brief Background colours for Order Entry Views based on the side (Buy, Sell) - Buy Side
*
*/ -->

但這是行不通的。 還嘗試了\\ var但沒有成功。

我看到doxygen正在解析此注釋塊，因為有錯誤消息：

/local/home/oberss2/working/branches/RIV-1158-Nexus-1.2.1/nexus_client/nexus_client/Themes/Generic.xaml:136：警告：未聲明或定義文檔符號“ nexus_client Generic OEBackgroundBrushBuy”。

我看不到為什么它對待屬性與XAML文件中的類（沒有被聲明）有什么不同。