Welcome to the Lounge

Member 10088171 wrote:

The problem with comments is that they are often not changed in sync with code updates. Another one is that meaningful comment today is often meaningless tomorrow. I am trying my best creating meaningful comments and this is an art and continuous learning

Member 10088171 wrote:

and despite best efforts issues with code comments are missed even by best reviewers.

1. Strip out all code within blocks (except block delimiters - i.e. if, do, for, while and switch code boundaries).
2. The remaining code and comments should clearly represent the method's psuedocode.  If it doesn't, you need to add comments.

/// <summary>
/// Performs a file copy (a better comment is required here).
/// </summary>
/// <returns>The result of the operation.</returns>
private MyClass MyMethod()
{
    // For each file whose name is less than 21 chars...
    int count = 0;
    foreach (MyFileObj file in _myFileCollection) {
        if (file.Name.Length <= 20) {
            // Copy it to the new location
            file.CopyTo(@"C:\SomePath\" + file.Name);
            count++;
        }
    }
 
    // A lot of other code
    // ...

    // Return result
    MyClass someObj = new MyClass();
    someObj.FileCount = count;
    return someObj;
}

// an add method to add two integers
    // add the two integers and return the result

// an add method to add two integers
-(int)add: (int)a b:(int)b
{
    // add the two integers and return the result
    return a+b;
}

What were they thinking when they wrote this piece of code?

Matt U. wrote:

These are just a few examples.

Matt U. wrote:

But does it benefit in any manner when coding in C#?

Matt U. wrote:

But C# is not C. Is it necessary?

Matt U. wrote:

But does it benefit in any manner when coding in C#?

private void Process(MyFileObj myFile)
{
    // myFile may be null if the user selected a folder rather than a file
    if (myFile != null)
    {
        // some files contain control characters, etc. so strip 'em out
        myFile.StripBadData();

        // Add the file to the collection of files to be processed by the thingummy
        _myFileCollection.Add(myFile);
    }
}

i++;

// i meaningless and not needed here
if ( itemCount > 0 )
{
    int i = itemCount;
    …
}
else
{
    int i = MAX_INT;
    …
}
// i meaningless and not needed here 

#region Variables
...
#endregion Variables

#region Fields
...
#endregion Fields

#region Properties
...
#endregion Properties

#region Constructors
...
#endregion Constructors



#region Methods

#region Private
...
#endregion Private

#region Protected
...
#endregion Protected

#region Public
...
#endregion Public

#endregion Methods