Throw helpers with a "reason (string)" overload?

[wstaelens]

code:

if (depth > 0) throw new ParserException("Comment tag is not closed");

we can't replace it with
ArgumentOutOfRangeException.ThrowIfGreaterThan(depth, 0, nameof(depth));
because useful information for user/log (Comment tag is not closed) is not added and depth doesn't say a thing here.

would be nice if we could give reasons to the exception throw helpers.

Or is there a reason this is not added?

[huoyaoyuan]

It is not a good choice to use the throw helper in such case. The exception ArgumentOutOfRangeException is for argument, which means the reason should be an input argument of a method is in correct. In this case, the called method and argument name is almost the whole reason.
It should not be used for representing bad state after doing complex logic. A different exception type like ParseException should be used instead.

[znakeeye]

Also, you would open the door to unwanted string allocations. E.g.:

// Always creates a string to be GC'ed
ArgumentOutOfRangeException.ThrowIfGreaterThan(
    depth,
    0,
    nameof(depth),
    $"Comment tag is not closed (depth = {depth})" // :-(
);

I just fixed such a performance bug in our codebase.