Visual Studioで自動コメントテキストをカスタマイズするにはどうすればよいですか？

StackOverflow https://stackoverflow.com/questions/425559

質問

Visual Studioで（＆quot; '' '＆quot;または＆quot; ///＆quot;と入力して）自動コメント機能をトリガーすると、ほとんどのXMLコメントの詳細が表示されます。ただし、通常はメソッドに履歴タグを追加して、時間の経過とともにメソッドに加えられた変更を追跡および変更できるようにします。

自動コメント機能をカスタマイズして、履歴タグを追加し、場合によっては一般的な名前-日付-プレースホルダーテキストを変更する方法はありますか？

役に立ちましたか？

解決

GhostDoc を使用することをお勧めします。メソッド名とパラメーターに基づいて///を使用して非常にスマートなコメントを生成します。また、完全にカスタマイズ可能です。

他のヒント

dgarciaが言ったようにツールを使用できると思いますが、バージョン管理の挿入子を作成するツールを選択してみてください。個人的には、「履歴」を保持する大ファンではありません。または、コード内のコメントを使用してプロジェクトを追跡します。

この方法が好きなら、独自のカスタマイズされたバージョンのスニペットを作成できます。スニッピー

このファイルをコピーあなたへ

マイドキュメント\ Visual Studio 2005 \コードスニペット[言語] \マイコードスニペット\

VB.NETで使用する場合は、ファイルの変更に注意してください

このヘルプを期待

Olivierへのコメントのフォローアップとして。ここにマクロのコピーがあります。コードを挿入した場所を確認するには、「実行履歴」セクションを参照してください。

    ''// InsertDocComments goes through the current document using the VS Code Model
    ''// to add documentation style comments to each function.
    ''
    Sub InsertDocComments()
        Dim projectItem As ProjectItem
        Dim fileCodeModel As FileCodeModel
        Dim codeElement As CodeElement
        Dim codeElementType As CodeType
        Dim editPoint As EditPoint
        Dim commentStart As String

        projectItem = DTE.ActiveDocument.ProjectItem
        fileCodeModel = projectItem.FileCodeModel
        codeElement = fileCodeModel.CodeElements.Item(1)

        ''// For the sample, don't bother recursively descending all code like
        ''// the OutlineCode sample does. Just get a first CodeType in the
        ''// file.
        If (TypeOf codeElement Is CodeNamespace) Then
            codeElement = codeElement.members.item(1)
        End If
        If (TypeOf codeElement Is CodeType) Then
            codeElementType = CType(codeElement, CodeType)
        Else
            Throw New Exception("Didn't find a type definition as first thing in file or find a namespace as the first thing with a type inside the namespace.")
        End If

        editPoint = codeElementType.GetStartPoint(vsCMPart.vsCMPartHeader).CreateEditPoint()

        ''// Make doc comment start.
        commentStart = LineOrientedCommentStart()
        If (commentStart.Length = 2) Then
            commentStart = commentStart & commentStart.Chars(1) & " "
        ElseIf (commentStart.Length = 1) Then
            commentStart = commentStart & commentStart.Chars(0) & commentStart.Chars(0) & " "
        End If

        ''// Make this atomically undo'able.  Use Try...Finally to ensure Undo
        ''// Context is close.
        Try
            DTE.UndoContext.Open("Insert Doc Comments")

            ''// Iterate over code elements emitting doc comments for functions.
            For Each codeElement In codeElementType.Members
                If (codeElement.Kind = vsCMElement.vsCMElementFunction) Then
                    ''// Get Params.
                    Dim parameters As CodeElements
                    Dim codeFunction As CodeFunction
                    Dim codeElement2 As CodeElement
                    Dim codeParameter As CodeParameter

                    codeFunction = codeElement
                    editPoint.MoveToPoint(codeFunction.GetStartPoint(vsCMPart.vsCMPartHeader))
                    ''//editPoint.LineUp()
                    parameters = codeFunction.Parameters

                    ''// Do comment.
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
                    editPoint.LineUp()
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart & "<summary>")
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart & "Summary of " & codeElement.Name & ".")
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart & "</summary>")
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart)

                    For Each codeElement2 In parameters
                        codeParameter = codeElement2
                        editPoint.Insert("<param name=" & codeParameter.Name & "></param>")
                        editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
                        editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart)
                    Next ''//param

                    ''// Do history tag.
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
                    editPoint.LineUp()
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart & "<history>")
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart & "Name   MM/DD/YYYY   [Created]")
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart & "</history>")
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbCrLf)
                    editPoint.Insert(Microsoft.VisualBasic.Constants.vbTab & commentStart)

                End If ''//we have a function
            Next ''//code elt member

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

何らかの理由で、保存、再構築、およびVisual Studioの再起動後、履歴タグが表示されません。誰かが私が行方不明になっている何かをここで見ることができますか？

vbは、xmlファイルを使用してデフォルトをロードします。 VBXMLDoc.xmlであり、ファイルの場所に関して実行しているバージョンによって異なります。

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top