Welcome to the Lounge

Argonia wrote:

Declaring all variables at the begining of the method is an old c++(i am not sure if it comes from c)

jschell wrote:

It is from C.

John Nurick wrote:

It's in Pascal, which AFAIK predates C. Which isn't to say that both didn't pick it up from some other language.

Gerry Schmitz wrote:

It's from COBOL.

/// <summary>
/// This is an addition method.
/// </summary>
private int Add(int a, int b)
{
    //Any monkey can understand what the next line does, 
    //but since my manager does not understand, I am writing this comment
    return a + b; // Add the two numbers and return the result
}

Matt U. wrote:

2. Variable declaration

Matt U. wrote:

foreach (MyFileObj file in _myFileCollection)

Matt U. wrote:

// Setup the class that will be returned
someObj = new MyClass();
someObj.FileCount = count;

// Setup the class that will be returned
someObj = new MyClass(); // Create a new instance of the MyClass class and store it in the someObj variable.
someObj.FileCount = count; // Store the value of the count variable in the FileCount property on the instance of the MyClass class stored in the someObj variable.

Richard Deeming wrote:

Whoops - you didn't declare the MyFile file variable at the top of the method!

IEnumerator<MyFileObj> enumerator;
MyFileObj file;

using (enumerator = _myFileCollection.GetEnumerator())
{
    while (enumerator.MoveNext())
    {
        file = enumerator.Current;
    }
}

// Setup the class that will be returned
someObj = new MyClass();
someObj.FileCount = count;

Gregory.Gadow wrote:

I'd written some time earlier and need to remember the type and initialized value for PersonId, I know where to look. I can look at the top of the code block much faster than I can pull up and use a search tool.

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;
}