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文件中的类（没有被声明）有什么不同。