Python Comments

Last modified on: October 19, 2024

<h3>Python Comments Overview</h3>
<p>Python provides several ways to add comments to your code, allowing developers to explain their code or disable certain lines for debugging purposes.</p>
<ol>
<li>
<p><strong>Single-line Comments</strong>: Begin with a <code>#</code> symbol.</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">
<pre class="language-python"><code># This is a single-line comment
x = 10  # This is an inline comment</code></pre>
</div>
</div>
</li>
<li>
<p><strong>Multi-line Comments</strong>: Though Python doesn&rsquo;t have explicit multi-line comment syntax, triple-quoted strings (<code>'''</code> or <code>"""</code>) are often used as comments.</p>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">
<pre class="language-python"><code>'''
This is a multi-line comment
explaining the purpose of
the following code block.
'''
print("Hello, World!")</code></pre>
</div>
</div>
</li>
<li>
<p><strong>Documentation Strings (Docstrings)</strong>: These are a special type of comment used for documenting modules, classes, and functions.</p>
<pre class="language-python" style="font-size: 14px;"><code>def add(a, b):
    """
    This function returns the sum of two numbers.
    :param a: first number
    :param b: second number
    """
    return a + b</code></pre>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">&nbsp;</div>
</div>
</li>
</ol>
<h3>Python Comments Example</h3>
<p>Here&rsquo;s a simple example that uses different types of comments:</p>
<pre class="language-python" style="font-size: 14px;"><code># Function to multiply two numbers
def multiply(a, b):
    '''This function multiplies two numbers and returns the result.'''
    return a * b

# Taking input from the user
x = int(input("Enter first number: "))  # User enters the first number
y = int(input("Enter second number: "))  # User enters the second number

# Displaying the result
print(f"The result is {multiply(x, y)}")  # Output the product
</code></pre>
<div class="dark bg-gray-950 contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative">
<div class="flex items-center text-token-text-secondary bg-token-main-surface-secondary px-4 py-2 text-xs font-sans justify-between rounded-t-md h-9">&nbsp;</div>
</div>
<h3>&nbsp;</h3>

Web Technology View More