मैं वर्तमान में पायथन के साथ शुरुआत कर रहा हूं और मेरे पास एक मजबूत पीएचपी बैकग्राउंड है और पीएचपी में मैंने javadocप्रलेखन टेम्पलेट के रूप में उपयोग करने की आदत डाल ली है ।
मैं सोच रहा था कि पायथन में प्रलेखन के javadocरूप में इसकी जगह है या नहीं docstring। यहां स्थापित सम्मेलन और / या आधिकारिक गिल्ड क्या हैं?
उदाहरण कुछ इस तरह है कि पायथन मानसिकता में फिट होने के लिए भी विस्तृत है या क्या मुझे यथासंभव संक्षिप्त होने की कोशिश करनी चाहिए?
"""
replaces template place holder with values
@param string timestamp formatted date to display
@param string priority priority number
@param string priority_name priority name
@param string message message to display
@return string formatted string
"""और अगर मैं थोड़ा बहुत थका हूं तो क्या मुझे इसके बजाय कुछ इस तरह से जाना चाहिए (जहां अधिकांश दस्तावेज __doc__विधि के माध्यम से मुद्रित नहीं होते हैं )?
# replaces template place holder with values
#
# @param string timestamp formatted date to display
# @param string priority priority number
# @param string priority_name priority name
# @param string message message to display
#
# @return string formatted string
def format(self, timestamp = '', priority = '', priority_name = '', message = ''):
"""
replaces template place holder with values
"""
values = {'%timestamp%' : timestamp,
'%priorityName%' : priority_name,
'%priority%' : priority,
'%message%' : message}
return self.__pattern.format(**values)
6
इससे पहले के सवाल पर थेरेसा के कई और जवाब भी हैं , जिनमें से यह एक डुप्लिकेट है।
—
एलेक्स दुपी जुले