Мне нужен какой-нибудь инструмент, желательно тот, который подключается к VS 2008/2010, который будет проходить через мои методы и добавлять комментарии XML о возможных исключениях, которые они могут бросить. Я не хочу, чтобы теги <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);
}
Обновление: кажется, что инструмент должен будет проходить через методы рекурсивно, например, метод1 вызывает метод method2, который вызывает метод3, который документируется как металирование NullReferenceException
, поэтому оба метода и метода1 документируются инструментом, также бросая NullReferenceException
. Инструменту также необходимо устранить дубликаты, например, если два вызова внутри метода документируются как металирование DirectoryNotFoundException
, метод будет перечислять только один раз <exception cref="System.IO.DirectoryNotFoundException"/>
.