Welcome to the Lounge

TheGreatAndPowerfulOz wrote:

what the code is doing but not why

/* check for null */
if (string.IsNullOrEmpty(something)) { ... }

// Declare variables

#region Private Members
// This should always start at 101 or kittens will die!
int thingy = 101;
#endregion

/* check for null, because if someObj is null, then bad data has been received from DataReceiver */
if (someObj != null) {...}

/* check for null because if someObj is not null, at this point, then something has gone wrong.  Look for errs 132-189*/
if (someObj != null) {...}

/* check for null because if someObj is null, then someSubObj is defective*/
if (someObj != null) {...}

// Declare a variable.
int i;
// Assign the variable.
i = 42;

Sander Rossel wrote:

Currently, I have a coworker who writes comments like:

public static class ErrorExtensions
{
     // non-generic version of 'IsNonNull omitted here

     // note: uses optional compiler directive 'ErrorsToConsole

     public static bool IsNonNull<T>(this T refobj, bool throwerror = false, string message = null)
    where T : class
    {
        if (refobj == null)
        {
            string mess = string.Format("instance of {0} is null: {1}",typeof(T).Name, message);
    
            if (throwerror)
            {
                throw new NullReferenceException(mess);
            }
            else
            {
#if ErrorsToConsole
                Console.WriteLine(mess);
#endif
            }
    
            return false;
        }
    
        return true;
    }
}