बहुत अच्छा यहाँ चर्चा ->What is the common header format of Python files?
अजगर docstring संक्षिप्त होना चाहिए, न कि वास्तव में संशोधन इतिहास, या कुछ भी सीधे वर्तमान संस्करण व्यवहार से संबंधित नहीं होते हैं। मुझे अभी तक "आदमी" शैली डॉकस्ट्रिंग देखने को नहीं मिला है और यह भी ठीक हो सकता है।
स्रोत नियंत्रण से स्वतंत्र संशोधन इतिहास के साथ एक फूल बॉक्स (जैसा कि कुछ संशोधन पूर्व-दिनांक अंततः आपके स्रोत नियंत्रण) पेपर पर कोड पढ़ने या ईमेल के रूप में वापस जाते हैं। हम हमेशा जुड़े हुए नहीं थे क्योंकि हम अभी हैं।
एक आधुनिक आईडीई का उपयोग करना यह पक्ष से बाहर हो गया है, लेकिन पुराने/बड़े उच्च स्तर के कार्यों के लिए देखा जा सकता है। कुछ दुकानों में साइन इन कोडर द्वारा नहीं किया जाता है, खासकर अगर कोड "दुकान से बाहर" किया गया है। कुछ साइनइन की आलसी, स्लोवेनली फैशन में टिप्पणी की जाती है।
तो यह भिन्न है, लेकिन:
#! /usr/bin/python
#--------------------------------#
# optional flower box
#--------------------------------#
"""
Multiple lines of doc if required
"""
import foo
import bar
__metastuff__='some value'
मैं देख रहा हूँ 'मेटा' जितना उपर होगा, विशेष रूप से "pycharm" के लिए यूट्यूब promotionals में। लोग इसे आयात के नीचे देखना पसंद करते हैं क्योंकि यह वास्तव में कोड है और आयात कोड से पहले आने की उम्मीद है। मैं कल्पना कर सकता हूं कि इसे दूर करना आसान हो सकता है। निम्न स्तर के कोड में संवेदनशील और सूचनात्मक टिप्पणियां वैसे भी ऊपर लिखी गई चीज़ों के मुकाबले ज्यादा मूल्यवान हैं।
वास्तविक दुनिया में, बस अपनी परियोजना पर और क्या कर रहे हैं और आप ठीक होंगे। वैसे भी एक टेम्पलेट का पुन: उपयोग करना आम है, या "प्रोटोटाइप" से कॉपी और पेस्ट (यानी ripoff)।
[पाइथन: सामान्य हेडर प्रारूप क्या है?] (Http://stackoverflow.com/questions/1523427/python-what-is-the-common-header-format) – Vyktor
@ विक्टर नोप। यह * ओपी के लिए उपयोगी हो सकता है, लेकिन यह एक अलग मुद्दा है। – delnan