मेरे पास मेरे परिभाषित कई कार्य हैं .bashrc, जिन्हें टर्मिनल में अंतःक्रियात्मक रूप से उपयोग करने का इरादा है। मैंने आम तौर पर उन्हें एक टिप्पणी के साथ पूर्ववर्ती उपयोग के बारे में बताया:
# Usage: foo [bar]
# Foo's a bar into a baz
foo() {
...
}
स्रोत कोड ब्राउज़ करते समय यह ठीक है, लेकिन typeटर्मिनल में चलाने के लिए यह अच्छा है कि फ़ंक्शन क्या करता है उसका त्वरित अनुस्मारक प्राप्त करें। हालाँकि यह (समझ में आता है) टिप्पणी शामिल नहीं है:
$ type foo
foo is a function
foo ()
{
...
}
जो मुझे सोच रहा था "क्या यह अच्छा नहीं होगा अगर इस तरह की टिप्पणियां बनी रहें ताकि typeउन्हें प्रदर्शित किया जा सके?" और पायथन के डॉकस्ट्रिंग्स की भावना में मैं इस के साथ आया:
foo() {
: Usage: foo [bar]
: "Foo's a bar into a baz"
...
}
$ type foo
foo is a function
foo ()
{
: Usage: foo [bar];
: "Foo's a bar into a baz";
...
}
अब उपयोग typeआउटपुट में सही शामिल है ! बेशक, जैसा कि आप देख सकते हैं कि उद्धृत करना एक ऐसा मुद्दा बन जाता है जो त्रुटि-रहित हो सकता है, लेकिन जब यह काम करता है तो यह एक अच्छा उपयोगकर्ता अनुभव होता है।
तो मेरा सवाल यह है कि क्या यह एक भयानक विचार है? वहाँ बेहतर विकल्प (एक तरह हैं man/ infoअतिरिक्त संदर्भ बैश कार्यों के उपयोगकर्ताओं प्रदान करने के लिए काम करता है के लिए)?
आदर्श रूप से मैं अभी भी उपयोग के निर्देशों को फ़ंक्शन परिभाषा के आस-पास स्थित होना चाहूंगा ताकि स्रोत कोड देखने वाले लोगों को भी लाभ मिल सके, लेकिन अगर ऐसा करने का एक "उचित" तरीका है तो मैं विकल्पों के लिए खुला हूं।
संपादित करें ये सभी काफी सरल सहायक शैली के कार्य हैं और मैं अंतःक्रियात्मक रूप से थोड़ा अतिरिक्त संदर्भ प्राप्त करना चाहता हूं। निश्चित रूप से अधिक जटिल लिपियों के लिए जो झंडे लहराएंगे मैं एक --helpविकल्प जोड़ूंगा, लेकिन इनके लिए हर चीज में मदद के झंडे जोड़ना कुछ हद तक भारी होगा। शायद यह केवल एक लागत है जिसे मुझे स्वीकार करना चाहिए, लेकिन यह :हैक हमारे संपादन को पढ़ने के लिए स्रोत को बहुत कठिन किए बिना यथोचित काम करता है।
--helpविकल्प जोड़ देगा ।