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/主題/ Generic.xaml：136：警告：記錄的符號`nexus_client通用OEBackgroundBrushBuy'未被聲明或定義。

我看不出爲什麼它會對待一個屬性與XAML文件中的類不同，它們都沒有聲明。