डॉक्युमेंटेशन में PEP 8
अब तक हमने देखा कि PEP 8 कोड के फंक्शनल हिस्सों को कैसे प्रभावित करता है। टिप्पणियाँ और डॉक्युमेंटेशन अधिक पढ़ने योग्य बनाने के लिए भी कुछ नियम होते हैं। इस अभ्यास में, आप विभिन्न तरह की टिप्पणियों को ठीक करके उन्हें PEP 8 के अनुरूप बनाएँगे।
कोड पर किए गए pycodestyle स्टाइल चेक का परिणाम नीचे दिया गया है।
my_script.py:2:15: E261 at least two spaces before inline comment
my_script.py:5:16: E262 inline comment should start with '# '
my_script.py:11:1: E265 block comment should start with '# '
my_script.py:13:2: E114 indentation is not a multiple of four (comment)
my_script.py:13:2: E116 unexpected indentation (comment)
यह अभ्यास पाठ्यक्रम का हिस्सा है
Python में Software Engineering Principles
अभ्यास निर्देश
pycodestyleके आउटपुट का उपयोग करके कोड की टिप्पणियों को संपादित करें ताकि वे PEP 8 के अनुरूप हों.
इंटरैक्टिव व्यावहारिक अभ्यास
इस अभ्यास को इस नमूना कोड को पूरा करके आज़माएँ।
def print_phrase(phrase, polite=True, shout=False):
if polite:# It's generally polite to say please
phrase = 'Please ' + phrase
if shout: #All caps looks like a written shout
phrase = phrase.upper() + '!!'
print(phrase)
#Politely ask for help
print_phrase('help me', polite=True)
# Shout about a discovery
print_phrase('eureka', shout=True)