VB.NET documentation and exception

Question

Let's say I have this sub in 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

Is it proper to call this ValidateNotNull (which is what I would call it in C#) or should I stick with Visual Basic terminology and call it ValidateNotNothing instead? Also, in my exception, is it proper to say "cannot be null", or would it be better to say "cannot be Nothing"?

I sort of like the way I have it, but since this is Visual Basic, maybe I should use Nothing. But since the exception itself is called ArgumentNullException, it feels weird to make the message say "cannot be Nothing".

Anthony Pegram · Accepted Answer · 2010-06-09 04:00:19Z

4

I think you're fine sticking with Null. It's not without precedent. For example, the .NET framework developers didn't create String.IsNothingOrEmpty for the VB community. And it also isn't like Null is some vague concept, anyone who has programmed or worked with a database for longer than a week has seen it.

With that in mind, it's OK to consider your audience. If your code is going into a class library that can be used by other developers, those developers may be accustomed to seeing null as null. On the other hand, if this is strictly part of some codebase that will only be maintained, then the VB folks looking at it may expect to see "Nothing." Conform to standards as best you can, but know that the standards of your language may not necessarily be the standards of your consumers.

But as said earlier, Null should be fine.

answered Jun 9, 2010 at 4:00

Anthony Pegram

128k28 gold badges229 silver badges252 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Peter Macej · Accepted Answer · 2010-06-09 07:14:07Z

1

Also, in my exception, is it proper to say "cannot be null", or would it be better to say "cannot be Nothing"?

Several tools (including our VSdocman) accept <see langword="null"/>. This will produce exactly the same text as MSDN: "null reference (Nothing in Visual Basic)". You can use it also for other keywords such as true, false, abstract, etc. See <see> tag syntax for more details.

answered Jun 9, 2010 at 7:14

Peter Macej

5,70532 silver badges52 bronze badges

1 Comment

Peter Macej Over a year ago

Ah, sorry. I misunderstood the question. I was referring to exception documentation where you use <c>null</c>. Now I found that you meant exception message.

Collectives™ on Stack Overflow

VB.NET documentation and exception

2 Answers 2

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related