1

methodA（）には、///xmlドキュメントシステムを使用したいと思います。methodA（）の前にmethodB（）を呼び出す必要があることを文書化したい。

誰かがmethodB（）の名前をrenamedMethodB（）に変更したとすると、コメント内の古いmethodB（）参照をrenamedMethodB（）に更新する必要があります。誰かがmethodB（）を削除したとすると（そして他にmethodB（）を使用していないと仮定して）、プログラムをコンパイルしないようにするか、少なくともmethodB（）コメントのために警告を生成してから、もう存在しないメソッドを参照します。

どこかでその一例を見たと思いますので、可能だと思います。どうすればいいのですか？

4

1 に答える 1

3

ユーザーがVisualStudioのリファクタリングメニューを使用する場合、文字列を検索してメソッドにコメントを付けるオプションがあります。そうでない場合、これを自動的に行うオプションはありません。

<see cref="OtherMethod"/>名前の変更を見逃すリスクを減らすために、コメントでは常に構成を使用してください。メソッド名を解決できない場合は、警告が表示されます。

例 ：

/// <summary>
/// This method will call <see cref="MethodB"/>
/// </summary>
public void MethodA()
{
    MethodBNew();
}

/// <summary>
/// Some method
/// </summary>
public void MethodBNew() // Formerly MethodB
{
}

このコードは警告を生成します。

PS：プロジェクトのプロパティでBuild Xmlドキュメントオプションがアクティブになっていると思いますが、そのような質問をした場合はそうだと確信しています。

于 2012-07-13T07:29:27.967 に答える