Docstrings

'''
Docstring in Python:
A docstring in Python is a special type of comment used to describe a module, class, method, or function. 
It is a string literal that appears as the first statement in the definition of the object it documents. 
Docstrings are typically enclosed in triple quotes (""" or '' to allow multi-line text.

Why Use Docstrings?
Documentation: Explains what the code does, its parameters, return values, exceptions, etc.
Readability: Makes code easier to understand for other developers (or your future self).
Automatic Documentation: Tools like help() and pydoc use docstrings to display information.
'''
#Example:
def square(n):
    '''Takes in a number n, returns the square of n'''
    print(n**2)
square(10)               #output = 100
#Here '''Takes in a number n, returns the square of n''' is a docstring which will not appear in the output.

print(square.__doc__)    #output = Takes in a number n, returns the square of n

'''
Python Comments vs Docstring:
1.Docstrings:
Syntax: Triple quotes(""" or '').
Placement: Inside functions, methods, classes, or modules. 
Purpose: Describes what the code does (documentation).
Access: Accessible at runtime using .__doc__ or help().
Best For: High-level description (purpose, usage, parameters, return values).
Tools Usage: Used by documentation tools (like pydoc, Sphinx).
Multi Lines: Supports multi-line text without # on each line.

2.Comments:
Syntax: Hash Symbol #.
Placement: Anywhere in the code.
Purpose: Explains specific lines or logic of code.
Access: Not accessible at runtime.
Best For: Explaining complex logic, clarifying code.
Tools Usage: Not used by documentation tools.
Multi Lines: Multi-line comments require multiple #.
'''

'''
PEP 8:
PEP 8 (Python Enhancement Proposal 8) is the official style guide for Python code. 
It provides guidelines and best practices for writing clean, readable, and consistent Python code.
It was written in 2001 by Guido Van Rossum, Barry Warsaw, and Nick Coghlan.
'''

    




 




Comments

Post a Comment

Popular posts from this blog

Print Function

#To print something in Python, we write print( ) #print is a function to perform any task. print("Hello World")                                    #output - Hello World #We use double quotes " " to make the object valid and to make it a string. #We can also use single quotes ' ' for the same. print('Hello World')                                      #output = Hello World print(5)                                                         #output - 5 #We didn't use double quote or single quote here as 5 is a number(a valid object) #To print multiple lines in print function, we use triple single or double quotes. print('''Hi How are you? I am good, Thank you''' print(...
Read more

Arithmetic Operators

 ''' Python has different types of operators. To create a calculator we require arithmetic operators. Operator        Operator Name                     Example +                Addition                                      24+9 -                Subtraction                                  24-9 *                Multiplication                             24*9 /                Division                                  ...
Read more

Sets in Python

''' Python Sets: In Python, a set is an unordered collection of unique elements.  Sets are useful when we need to store a collection of items without any duplicates. Key Characteristics of Sets: 1. Unordered: The items have no defined order, and their position can change. 2. Unique Elements: No duplicate values are allowed. 3. Mutable: Sets can be modified after creation (elements can be added or removed). 4. Heterogeneous: A set can contain elements of different data types. ''' s1 = {1, 2, 3, 4} print(s1)                #output = {1, 2, 3, 4} s2 = {1, 1, 2, 3, 4, 4} print(s2)                #output = {1, 2, 3, 4}   #Duplicates are automatically removed info = {"Sindhu", 24, True, 2002} print(info)              #output = {24, True, 2002, 'Sindhu'}  #Here we can see that the items in set occur in random order, and hence they cannot be accessed using index...
Read more