अजगर

Question

पढ़ा है क्या PEP8 टिप्पणियों के विषय पर कहना चाहता है के बावजूद में कोड की एकल तर्ज पर लांग टिप्पणियाँ, मैं अभी भी अजगर में कोड की एकल लाइनों टिप्पणी करने के लिए कैसे सबसे अच्छा आश्चर्य है।

x = x + 1     # Compensate for border 

लेकिन अगर लाइन या टिप्पणी है लंबे समय तक बातें और अधिक कठिन मिलता है: जब प्रश्न में कोड की पंक्ति (बहुत) कम है

उदाहरण दिया ठीक है। उदाहरण के लिए:

import numpy as np 
import matplotlib.pyplot as plt 
a = np.random.random([3, 3]) 
b = np.random.random([3, 3]) 
coords = zip(a.ravel(), b.ravel()) # match elements of a with elements of b ignoring shape 
plt.scatter(*zip(*coords)) 

टिप्पणी काफी लंबी है, और कोड की रेखा भी है, जो पूरी चीज स्वीकार्य रेखा लंबाई से अधिक लंबी बनाती है।

मैं आमतौर पर रेखा से ऊपर टिप्पणी डाल दिया, लेकिन यह तो स्पष्ट नहीं है टिप्पणी plt लाइन या नहीं पर लागू होता है या नहीं:

# match elements of a with elements of b ignoring shape 
coords = zip(a.ravel(), b.ravel()) 
plt.scatter(*zip(*coords)) 

मैं दो लाइनों के बीच एक नई पंक्ति डालने से यह चारों ओर पाने के लिए करते हैं :

# match elements of a with elements of b ignoring shape 
coords = zip(a.ravel(), b.ravel()) 

plt.scatter(*zip(*coords)) 

मैं भी इस किया है, लेकिन यह हद से ज़्यादा एक सा लगता है:

""" 
match elements of a with elements 
of b ignoring shape 
""" 
# ================================ 
coords = zip(a.ravel(), b.ravel()) 
# ================================ 
plt.scatter(*zip(*coords)) 

क्या ऐसा करने का एक स्वीकार्य तरीका है?

Answer 1

शैली है कि मैं देखने के लिए सबसे ऊपर टिप्पणी एक पंक्ति रहा है लग रहे हैं। ज्यादातर मामलों में, आपका कोड पढ़ने वाला कोई व्यक्ति समझ जाएगा जब दस्तावेज़ व्यवहार समाप्त होता है। यदि यह स्पष्ट नहीं है कि संदर्भित रेखा के नीचे कोड क्या है, तो शायद इसे भी टिप्पणी करने की आवश्यकता है।

मैं भी मेरी टिप्पणी घनीभूत करने की कोशिश करेगा। के बजाय:

# match elements of a with elements of b ignoring shape 
coords = zip(a.ravel(), b.ravel()) 

मैं लिखने होगा:

coords = zip(a.ravel(), b.ravel()) # match elements of a and b, ignore shape 

इस PEP8 के लिए पर्याप्त छोटा होगा। हालांकि यह लंबी लाइनों के साथ संभव नहीं हो सकता है।