none
///で自動で表示されるXMLドキュメントコメントをカスタマイズしたい RRS feed

  • 質問

  • <環境>

    Windows XP Professional Ver2002 (SP2)
    VisualStudio2005 Proffessional Edition

    .NET Framework2.0

    Visual C# 2005

     

     

    Visual Studio IDE の、スマート コメント編集と呼ばれる機能について質問です。

    コード エディタで /// 区切り記号を入力すると、<summary> タグと </summary> タグが

    自動的に挿入され、これらのタグの内側にカーソルが移動できる機能ですが、

    たとえば、

    ----------------------------

    [C#]
    public int Plus(int val)
    {
    }
    ----------------------------

    というメソッドがあったとき、このメソッドの前の空白行で
    ///
    と入力すると、自動的に次のようにドキュメントコメントが挿入されますが、

    ----------------------------

    [C#]
    /// <summary>
    ///
    /// </summary>
    /// <param name="val"></param>
    /// <returns></returns>

    public int Plus(int val)
    {
    }
    ----------------------------

     

    さらに、作成日や作成者等を入力できるタグを追加できないかな、と思っています。

     

    ex)---------------------------

    /// <summary>
    /// 
    /// </summary>
    /// <remarks>
    /// <newpara><作成者>aaaaa</作成者></newpara>
    /// <newpara><作成日>2008/01/20</作成日></newpara>
    /// <newpara><更新者></更新者></newpara>
    /// <newpara><更新日></更新日></newpara>
    /// </remarks>
    /// <param name="val"></param>

    /// <returns></returns>
    ---------------------------

     

    説明がわかりづらくて申し訳ありませんが、

    やりたいことは、ビルドで生成(任意の場所に出力)できるXMLドキュメントファイルについてではなく、

    コーディング中に、「///」を入力して自動的に表示される雛形のようなものに

    何行かオリジナルのものを追加できないか、ということです。(自動表示される雛形をカスタマイズしたい)

     

    スニペット機能のように、オリジナルで作成・追加したり、編集できたりしないでしょうか?

     

    どこかに、XMLドキュメントコメントのファイルがあり、それを変更できたりしないでしょうか?

    (いろんなXMLファイルを調べてみましたが、見付かりませんでした。)

     

    VB用に、「カスタムドキュメントコメント設定」できるようなものはあったんですが、

    C#では、見付かりませんでした。(設定できませんでした)

     

    どなたかご存知の方がいらっしゃいましたら、返信お願いします。
    説明が長くてすみません。

    よろしくお願いいたします。

    2008年2月14日 9:25

回答

  • >Azulean さん

    返信ありがとうございます。

    どこを調べても簡単に編集できるような方法が載っていないので、

    確かに簡単な手法があればとっくに出てきているんでしょうね。

    解決にはなりませんが、コードスニペットをうまく使って、使ってみたいと思います。

    ありがとうございました。

    2008年2月21日 3:07

すべての返信

  • 似たような話題を見つけました。

     

    VB.NetにおけるXMLコメントタグのカスタマイズ - MSDN フォーラム
    http://forums.microsoft.com/MSDN-JA/ShowPost.aspx?PostID=282294&SiteID=7

    2008年2月14日 12:14
  • Tesla. さん、

    返信ありがとうございます。

    こちらに書き込む前に、既にその質問もリンク先の記事も読みました。

    しかし、難しくてよくわかりませんでした・・・。

    MSDN マガジンの記事のなかのマクロの設定も挑戦してみたんですが、うまくいきませんでした。

    VBのコーディングもマクロの仕組みもよくわからなくて・・・。

    XMLファイルに記述を追加する、みたいに簡単には出来ないということなんでしょうかねぇ・・。

    2008年2月15日 3:24
  •  February さんからの引用

    MSDN マガジンの記事のなかのマクロの設定も挑戦してみたんですが、うまくいきませんでした。

    うまくいかなかった点を解決したいのであれば、どのようなことを試して、どうなったかを挙げてください。

     

     February さんからの引用

    VBのコーディングもマクロの仕組みもよくわからなくて・・・。

    VBのコーディングが「嫌」というのであれば、C#でアドインという方向性も考えますが、マクロよりも大変だと思います。

    #できるかどうか検討していません。

     

     February さんからの引用

    XMLファイルに記述を追加する、みたいに簡単には出来ないということなんでしょうかねぇ・・。

    簡単な手法があれば既に出てきていると思います。

    XMLコメントのカスタマイズは個々の要求を出すときりがなく、コードスニペットのような限定的なものでは満足できないとも思えます。

    そういったことを考えると、仕様としてカスタマイズを認めていなくても不思議には思いません。

    2008年2月15日 12:34
    モデレータ
  • >Azulean さん

    返信ありがとうございます。

    どこを調べても簡単に編集できるような方法が載っていないので、

    確かに簡単な手法があればとっくに出てきているんでしょうね。

    解決にはなりませんが、コードスニペットをうまく使って、使ってみたいと思います。

    ありがとうございました。

    2008年2月21日 3:07