Skip to content

Gendarme.Rules.BadPractice.ToStringShouldNotReturnNullRule(2.10)

Jump to bottom
Sebastien Pouliot edited this page Jan 22, 2011 · 2 revisions

ToStringShouldNotReturnNullRule

Assembly: Gendarme.Rules.BadPractice
Version: 2.10

Description

This rule checks for overridden ToString() methods which return null. An appropriately descriptive string, or string.Empty, should be returned instead in order to make the value more useful (especially in debugging).

Examples

Bad example:

public override string ToString ()
{
    return (count == 0) ? null : count.ToString ();
}

Good example:

public override string ToString ()
{
    return count.ToString ();
}

Notes

  • Before Gendarme 2.4 this rule was named ToStringReturnsNull.

Note that this page was autogenerated (3/17/2011 9:31:58 PM) based on the xmldoc comments inside the rules source code and cannot be edited from this wiki. Please report any documentation errors, typos or suggestions to the Gendarme Mailing List. Thanks!

Clone this wiki locally