VB.NET документация и исключение - PullRequest
Новая
       11

VB.NET документация и исключение

0 голосов
/ 09 июня 2010

Допустим, у меня есть этот саб в VB.NET:

    ''' <summary>
    ''' Validates that <paramref name="value"/> is not <c>null</c>.
    ''' </summary>
    '''
    ''' <param name="value">The object to validate.</param>
    '''
    ''' <param name="name">The variable name of the object.</param>
    '''
    ''' <exception cref="ArgumentNullException">If <paramref name="value"/> is <c>null</c>.</exception>
    Sub ValidateNotNull(ByVal value As Object, ByVal name As String)
        If value Is Nothing Then
            Throw New ArgumentNullException(name, String.Format("{0} cannot be null.", name))
        End If
    End Sub

Правильно ли вызывать этот ValidateNotNull (то, что я бы назвал в C #) или мне следует придерживаться терминологии Visual Basic и вместо этого называть его ValidateNotNothing? Кроме того, за моим исключением, правильно ли говорить «не может быть нулем» или лучше сказать «не может быть ничем»?

Мне нравится то, как я это делаю, но, поскольку это Visual Basic, возможно, мне стоит ничего не использовать. Но так как само исключение называется ArgumentNullException, кажется странным заставлять сообщение говорить «не может быть ничем».

Ответы [ 2 ]

4 голосов
/ 09 июня 2010

Я думаю, что ты в порядке с Нулем. Это не без прецедента. Например, разработчики платформы .NET не создали String.IsNothingOrEmpty для сообщества VB. И это также не то, что Null - это какая-то расплывчатая концепция: любой, кто программировал или работал с базой данных более недели, видел это.

Имея это в виду, все в порядке, чтобы рассмотреть вашу аудиторию. Если ваш код входит в библиотеку классов, которая может использоваться другими разработчиками, эти разработчики могут привыкнуть видеть нуль как ноль. С другой стороны, если это строго часть некоторой кодовой базы, которая будет сохраняться только тогда, то пользователи VB, смотрящие на нее, могут ожидать «Ничего». Соблюдайте стандарты как можно лучше, но знайте, что стандарты вашего языка не обязательно должны быть стандартами ваших потребителей.

Но, как уже было сказано, с Null все должно быть в порядке.

1 голос
/ 09 июня 2010

Также, за моим исключением, правильно ли говорить «не может быть нулем», или лучше сказать «не может быть ничем»?

Несколько инструментов (включая наш VSdocman ) принять,В результате будет получен точно такой же текст, что и в MSDN: «нулевая ссылка ( Ничего в Visual Basic)».Вы также можете использовать его для других ключевых слов, таких как true, false, abstract и т. Д. См. синтаксис тега для получения более подробной информации.

...