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

文件级注释工作正常。

我还 class 在 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 文件中的 class 有任何不同，两者都没有声明。

WPF 的 Doxygen 文档

Doxygen Documentation for WPF

c#

wpf

xaml

documentation

doxygen