আমি বর্তমানে পাইথন দিয়ে শুরু করছি এবং আমার দৃ PH় পিএইচপি ব্যাকগ্রাউন্ড রয়েছে এবং পিএইচপি-তে আমি 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
থেরাও এর আরও অনেক উত্তর এর আগের প্রশ্নে যা এটি একটি সদৃশ।
—
অ্যালেক্স ডুপয়
সম্ভাব্য সদৃশ পাইথন ডকস্ট্রিং ফর্ম্যাটটি কী?
—
zvone