Minds of code, Structures

 Minds of code

✅ All of code lines must be have comments

Minds of code

While it’s a good practice to comment your code, not every line of code necessarily needs a comment. Comments should explain why something is done, any limitations, and anything that isn’t immediately obvious from the code itself. Here’s an example:

# Function to calculate the sum of two numbers
def add(a, b):
    # Add the numbers
    result = a + b

    # Return the result
    return result

In this example, the comments help explain what the function does and how it works. However, in a real-world scenario, this might be considered over-commenting because the code is self-explanatory. A more appropriate version might look like this:

def add(a, b):
    """Calculate and return the sum of two numbers."""
    return a + b

In this version, there’s a single comment explaining what the function does, which is all that’s needed in this case. Remember, the goal of comments is to improve readability and understanding of your code. If your code is already clear and easy to understand, additional comments can sometimes be more distracting than helpful.

Bạn học rất nhiều ngôn ngữ khác nhau, do đó, mỗi một dự án mà bạn tạo ra bạn sẽ không nhớ là bạn đã làm được đến đâu. Khi giải thích các dòng code bạn sẽ quay lại một cách nhanh chóng và dễ dàng hơn.