Должен ли я документировать исключения, которые никогда не возникнут? [закрыто] ⇐ C#

[Anonymous]

Это вопрос о лучших практиках. У меня есть класс, примерно структурированный следующим образом:

Код: Выделить всё

// My actual class couples observers and observables, but I didn't want to overcomplicate this question.

public class MyClass
{
private HashSet mySet = new();
private HashSet myOtherSet = new();
private Dictionary myDictionary = new();

/// Thrown when  was already added to other.
public bool Add(int value)
{
// Return false if the value is already present.
if (!mySet.Add(value))
{
return false;
}

foreach (var other in myOtherSet)
{
// Use Dictionary.Add method to ensure that an exception is thrown if the key already existed,
// even though we never expect this to occur.
myDictionary.Add((value, other), value + other);
}

return true;
}
}

Поскольку я помещаю свои значения в хэш-набор перед использованием их в словаре, я точно знаю, что исключение, создаваемое myDictionary.Add, никогда не произойдет при нормальных обстоятельствах ( Отражение исключено). Поскольку я не ожидаю, что мой метод выдаст ошибку, если он используется как обычно, следует ли мне добавить /// документацию?
Не удалось найти четкое описание ответ в документации.

Подробнее здесь: https://stackoverflow.com/questions/791 ... ever-occur