Utilisation de Doxygen avec Visual Studio 2010

J'ai des difficultés efficacement Doxygen avec Visual Studio 2010 et C++.

Il n'y a pas d'autre fonction pour les commentaires que "l'onu/lignes de commentaire"? Par exemple générer des commentaires sur les talons et en ajoutant /// après une nouvelle ligne.

Aussi, je me demande ce qui est nécessaire à l'affichage de ces Commentaires à l'intérieur de la fonctionnalité IntelliSense dans VS2010?

source d'informationauteur Sven

  1. 12

    Selon la La Documentation MSDNtous les commentaires à l'aide de // ou /* délimiteurs sera affiché à côté du membre associé de l'IntelliSense liste des Membres.

    Vous pouvez utiliser doxygen XML de sortie ou le Documentation XML généré par Visual Studio que IntelliSense d'entrée.

    La /doc de la documentation explique comment utiliser la documentation XML avec IntelliSense:

    D'utiliser le générés .fichier xml avec IntelliSense, rendre le nom de fichier de l' .fichier xml de même que le montage que vous souhaitez soutenir et mettre la .fichier xml se trouve dans le même répertoire que l'assemblée. Lorsque l'assemblée est référencé dans le projet Visual Studio, le .fichier xml est également constaté.

    AtomineerUtils est l'un des meilleurs Visual Studio add-ins pour doxygen/javadoc/DocXML de la documentation. Ce n'est pas gratuit, mais rien sur la liste de doxygen des outils d'aide est destiné à Visual Studio 2010.

  2. 4

    Le meilleur que j'ai été en mesure de venir avec ma propre a été une collection de macros. J'ai regardé autour pour les sites web qui peuvent avoir agrégées utiles Visual Studio doxygen macros ensemble, mais ont rencontré jusqu'à présent vide. Mais, à l'aide de Visual Studio modèle de code à l'auto-remplir la documentation peut être vraiment pratique. Voici une macro que j'ai fait pour créer de la documentation pour la fonction que le curseur est actuellement en:

    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

    N'hésitez pas à modifier ou réutiliser cette macro, et je souhaite la bienvenue à toutes les critiques.