Как правильно указать в коде документации, функция может вернуть ноль на C #?

Question

Я создаю некоторую документацию по коду и хочу правильно отобразить, что функция может возвращать ноль, если ресурс не найден.

Метод с использованием некоторой документации по коду, которую я создал, с автоматическим включением GhostDocсгенерированная документация в качестве основы:

///<summary>Gets something for the specified unique identifier.</summary>
///<param name="id">Something's unique identifier.</param>
///<returns>Something if found; otherwise <c>null</c>.</returns>
private Something GetSomethingById(int id)
{ }

В настоящее время я использую XML-тег вокруг Null, но я хотел знать, является ли это лучшим / правильным способом.

Answer 1

Для дальнейшего использования после некоторого изучения кода Microsoft, т. Е. Декомпиляции некоторых библиотек DLL, я обнаружил, что они используют следующий стандарт: <paramref name="sourceTimeZone" /> is <see langword="null" />.

Пример извлечен из System.TimeZoneInfo.

Не знаю, ссылался ли @Ian на свой комментарий.