メソッドを調べて、スローされる可能性のある例外についてXMLコメントを追加するツール、できればVS2008/2010にプラグインするツールが必要です。<summary>
自分で入力するので、または他のXMLタグを生成したくありませんが、 private
/protected
メソッドでも、どの例外がスローされるかを確認できれば便利です。それ以外の場合は、メソッドを調べて、メソッド内のすべてのメソッド呼び出しにカーソルを合わせて例外のリストを表示し、そのメソッドの<exception
リストを更新して例外のリストを含めます。多分VSマクロはこれを行うことができますか?
これから:
private static string getConfigFilePath()
{
return Path.Combine(Environment.CurrentDirectory, CONFIG_FILE);
}
これに:
/// <exception cref="System.ArgumentException"/>
/// <exception cref="System.ArgumentNullException"/>
/// <exception cref="System.IO.IOException"/>
/// <exception cref="System.IO.DirectoryNotFoundException"/>
/// <exception cref="System.Security.SecurityException"/>
private static string getConfigFilePath()
{
return Path.Combine(Environment.CurrentDirectory, CONFIG_FILE);
}
更新: ツールはメソッドを再帰的に実行する必要があるようです。たとえば、method1は、throwingとして文書化されているmethod3を呼び出すmethod2を呼び出すNullReferenceException
ため、method2とmethod1の両方がツールによってthrowingとして文書化されますNullReferenceException
。また、ツールは重複を排除する必要があります。たとえば、メソッド内の2つの呼び出しがスローとして文書化されている場合DirectoryNotFoundException
、メソッドは1回だけリスト<exception cref="System.IO.DirectoryNotFoundException"/>
されます。