Как называть методы, которые не обрабатывают исключений?

Question

[romaro]

Иногда вызовы методов выстраиваются в цепочку и нужно подчеркнуть, что исключение будет передано без какой либо обработки. Раньше начинал названия таких методов с Try, но это конфликтует с общепринятым TryParse Pattern.

/// Этот метод так же не обрабатывает исключений
TryDoSomething2() 
{
   /// Этот метод может завершиться с "ожидаемым" исключением
   TryDoSomething1();
}

/// Здесь исключение будет обработано
DoSomething3() 
{
  try {
    TryDoSomething2();
  } catch {
    ...
  }
}

Существует ли какой-то паттерн для именования таких методов? Пока начал помечать их кастомным атрибутом:

[Throwable]
DoSomething() {...}

Answer 1

[Hemul GM]

Все методы изначально пишутся без обработки исключений и следовательно все методы могут кинуть исключение. Писать в каждом методе обработку ошибок просто так - глупо, тем более, если нет корректного противодействия ошибкам. Помимо всего этого, если ты втупую не будешь глушить все исключения без исключения (хе-хе), а обрабатывать только известные тебе исключения, то никто тебе не гарантирует, что не возникнет исключение, которое будет проброшено наверх, которое ты не обрабатываешь

Answer 2

[Василий Банников]

Их не принято никак по особенному отмечать.

Comments

[romaro]

Вот и гугл мне ничего не находит. Но привычка акцентировать внимание на таких методах уже сформировалась. Пока буду выпиливать приставку Try, чтобы не нарушать устоявшийся паттерн, и заменять на атрибут:

[AttributeUsage(AttributeTargets.Method)]
    public class ThrowableAttribute : Attribute
    {
    }

[Василий Банников]

romaro,
1. Throwable переводится как "кидаемый", а не выбрасывающий
2. Если ты никак не обрабатываешь исключения - значит это непредвиденные исключения и их появление сигнализирует о том что произошла какая-то очень нехорошая ошибка.
3. Если это всё-таки предвиденная ошибка, то ты можешь перечислить кидаемые исключения или хотябы их причины в документирующем комментарии - там даже специальная секция есть.
4. Формально тебе следует отмечать таким атрибутом все методы, кроме Try*, тк абсолютно любой вызов метода в .NET может закончиться исключением (на самом деле даже Try*)

PS: что вообще тебе даёт это акцентирование?

Answer 3

[Сергей Соловьев]

1. Есть Try* методы. Они возвращают bool - была ли операция успешна, а реальное возвращаемое значение передается через out параметр

2. Внутри своих проектов я использую *Safe постфикс. Но использую я их только внутри класса и только для того, чтобы не писать TryGet*(out ...) конструкцию

3. В док. строке можешь в какой-нибудь remarks секции указать, что метод не выкидывает исключение