While investigating a routine bug fix today, I came across some code that can only be described as a buried cry for help …

public void Adjust(
    DateTime? open, DateTime? due, DateTime? close)
{
    if (!open.HasValue)
        throw new ArgumentNullException("open");
    if (!due.HasValue)
        throw new ArgumentNullException("due");
    if (!close.HasValue)
        throw new ArgumentNullException("close");
    // ...
}

Why would a developer declare parameters as nullable DateTimes and then immediately write guard clauses to prevent nulls from being accepted.

If you don’t want to support nulls, use a regular date time.

There are two lessons to learn here, one specific and one general.

The specific lesson: Use the right type for each parameter - use the most liberal type that makes sense (for example, use IEnumerable<T> instead of IList<T> unless you need indexed access), but no more liberal (don’t use DateTime? unless you’re willing to accept nulls).

The general lesson: Don’t make code more complex than it needs to be - do things the simplest way that makes sense. Being a developer is hard enough, we shouldn’t go out of our way to make it harder.

Comments

blog comments powered by Disqus
Next Post
Looking forward to 2012  31 Dec 2011
Prior Post
A story about Magic  10 Dec 2011
Related Posts
Simple Queues  17 Nov 2018
Enqueuing Values  10 Nov 2018
Dequeuing Values  03 Nov 2018
Designing the External API  27 Oct 2018
Introducing the Priority Queue  20 Oct 2018
A better approach to reflection  13 Oct 2018
Avoiding Magic Strings  06 Oct 2018
Capturing Validation Metadata  29 Sep 2018
Modelling Validation Metadata  22 Sep 2018
Validation Metadata  15 Sep 2018
More csharp posts »
Archives
December 2011
2011