How to Write Clear and Efficient Python Comments

In this video, we provide a detailed explanation of using comments in Python and their importance. Learn how to make your code more understandable and maintainable with simple symbols, from single-line to multi-line comments. We also discuss the necessity of concise and clear comments, avoiding redundancy, and updating comments promptly when the code changes. Watch the video to learn how to enhance the readability and professionalism of your code.

1 . Example Demo Video.

2. Python Source Code.

def single_line_comments():

    # This is a single-line comment explaining the following code
    x = 42  # This comment explains the purpose of the variable x
    print(x)  # Output the value of x
    #print(x)

def multi_line_comments():

    # This is a multi-line comment
    # that spans multiple lines.
    # It is useful for explaining
    # more complex code.

    """
    This is also a multi-line comment.
    You can use triple-quoted strings
    to write comments spanning multiple lines.
    """

    '''
    This is also 
    multiple line comments.
    '''

    '''
    print('hello')
    '''
    
    x = 5

    y = 3.14  # Variable representing the value of pi
    area = y * (x ** 2)  # Calculate the area of a circle with radius x
    print(area)  # Output the area of the circle



# Calculate the factorial of a number using recursion
def factorial(n):
    # If the number is 0 or 1, return 1 (base case)
    if n == 0 or n == 1:
        return 1
    # Otherwise, return n multiplied by the factorial of n-1
    else:
        return n * factorial(n - 1)
    

def be_clear_and_concise():

    print(factorial(5))  # Output: 120


# Initially, this function used a loop to sum the elements of a list.
# Now, it uses the built-in sum() function for simplicity and efficiency.
def sum_list(lst):
    '''
    sum = 0
    for i in lst:
        sum += i
    '''
    return sum(lst)

def update_comments_when_necessary():
    print(sum_list([1, 2, 3, 4, 5]))  # Output: 15



def avoid_redundant_comments():
    # This is a redundant comment: Add two numbers
    a = 5
    b = 10
    sum = a + b  # This comment is unnecessary because the code is self-explanatory
    print(sum)  # Output: 15


if __name__ == "__main__":

    single_line_comments()

    #multi_line_comments()

    #be_clear_and_concise()

    #update_comments_when_necessary()

    #avoid_redundant_comments()