将 Doxygen 与 Visual Studio 2010 结合使用

Question

我在将 Doxygen 与 Visual Studio 2010 和 C++ 一起有效使用时遇到困难。

除了“取消/注释行”之外没有其他注释功能吗？例如，生成注释存根，并在新行后添加 ///。

另外，我想知道需要什么才能在 VS2010 的 IntelliSense 功能中显示这些注释？

Answer 1

根据 MSDN 文档，任何使用 // 的注释 或 /* 分隔符将显示在 IntelliSense 成员列表中关联成员的旁边。

您可以使用 doxygen 的 XML 输出或 Visual Studio 生成的 XML 文档作为智能感知输入。

/doc 文档说明了如何将 XML 文档与 IntelliSense 结合使用：

要将生成的 .xml 文件与 IntelliSense 一起使用，请使 .xml 文件的文件名与要支持的程序集相同，并将 .xml 文件放在与程序集相同的目录中。当在 Visual Studio 项目中引用该程序集时，也会找到 .xml 文件。

AtomineerUtils 是 doxygen/javadoc/DocXML 文档的最佳 Visual Studio 插件之一。它不是免费的，但 doxygen 帮助工具列表中没有任何内容是针对 Visual Studio 2010 的。

Answer 2

我自己能想到的最好的办法就是宏的集合。我四处寻找可能将一些有用的 Visual Studio doxygen 宏聚合在一起的网站，但到目前为止还是空的。但是，使用 Visual Studio 的代码模型自动填充文档确实非常方便。这是我为插入符号当前所在的函数创建文档而制作的宏：

Sub FunctionDoc()
    DTE.UndoContext.Open("Function Doc")
    Try
        Dim caretPosition As TextPoint = DTE.ActiveDocument.Selection.ActivePoint
        Dim element As CodeElement = _
            caretPosition.CodeElement(vsCMElement.vsCMElementFunction)
        If element.Kind <> vsCMElement.vsCMElementFunction Then
            MsgBox("That is not a function")
            Exit Sub
        End If
        Dim func As CodeFunction = element
        If func Is Nothing Then
            MsgBox("That is not a function")
            Exit Sub
        End If

        Dim ts As TextSelection = DTE.ActiveDocument.Selection
        ts.StartOfLine()
        ts.NewLine()
        ts.LineUp()
        Dim functionName As String = func.Name
        ts.Text = "//-----------------------------------------------------------------------------"
        ts.NewLine()
        ts.Text = "//  FUNCTION  "
        ts.Text = func.FullName
        ts.NewLine()
        ts.Text = "/// \brief    "
        Dim endline As Integer = ts.BottomPoint.Line
        Dim endoffset As Integer = ts.BottomPoint.LineCharOffset
        ts.NewLine()
        ts.Text = "///           "
        ts.NewLine()
        For Each param As CodeParameter In func.Parameters
            ts.Text = "/// \param    "
            ts.Text = param.Name
            ts.Text = ". "
            ts.NewLine()
        Next
        If func.Type.TypeKind <> vsCMTypeRef.vsCMTypeRefVoid Then
            ts.Text = "/// \return   "
            ts.Text = func.Type.AsFullName
            ts.Text = " "
            ts.NewLine()
        End If
        ts.Text = "//-----------------------------------------------------------------------------"
        ts.MoveToLineAndOffset(endline, endoffset)

    Finally
        DTE.UndoContext.Close()
    End Try
End Sub

请随意编辑或重用此宏，我欢迎任何批评。