एक फ़ंक्शन नाम के साथ एक वाक्य की शुरुआत? [बन्द है]


42

कभी-कभी कुछ टाइप करते समय जो केस-संवेदी प्रोग्रामिंग भाषा से संबंधित होता है, मैं अंत में एक फ़ंक्शन नाम के साथ एक वाक्य शुरू करता हूं। अब अंग्रेजी राज्य के नियम कि एक वाक्य में पहले शब्द को पूंजीकृत करने की आवश्यकता है; फ़ंक्शन का नाम लोअरकेस है, हालांकि। यदि आप सोच रहे हैं कि मैं ऐसा क्या कह सकता हूं, जिसके परिणामस्वरूप पहला शब्द एक फ़ंक्शन नाम होगा, तो यह उदाहरण लें:

आपका फ़्रेड कार्यान्वयन टूट गया है। फ़्रेड को कितने बाइट्स पढ़ने के लिए वापस लौटना पड़ा।

मैं समझता हूँ कि मैं के दूसरे उदाहरण बदल सकता है fread के लिए यह लेकिन मैं सिर्फ वाक्य को फिर से लिखने की तुलना में इस दूसरे से निपटने का सबसे अच्छा तरीका जानना चाहते हैं। क्या मुझे फ़ंक्शन नाम को कैपिटलाइज़ करना चाहिए? एक ही तरीका है कि मैं एक वाक्य के रूप में "वाक्य को फिर से लिखना" सुनना चाहूंगा अगर वाक्य को नाम के साथ शुरू करना कुछ अंग्रेजी नियम का उल्लंघन करता है जिसके बारे में मुझे जानकारी नहीं है। संपादित करें: मैं वास्तव में इन उत्तरों के लिए सभी को धन्यवाद देता हूं। उन्होंने मुद्दे में मेरी अंतर्दृष्टि को बदल दिया है और सुधार किया है। मैंने इससे काफी कुछ सीखा है। मुझे बहुत आश्चर्य है कि मैंने इन सरल लेकिन अच्छे समाधानों के बारे में नहीं सोचा।

मुझे लगता है कि सजा को वैकल्पिक करने पर मेरा रुख बहुत कठिन था और अब मुझे इन अच्छे उत्तरों के कारण पता चलता है कि कुल मिलाकर वाक्य को बदलना इन मामलों से निपटने के लिए सबसे अच्छा विकल्प प्रतीत होता है, क्योंकि यह फ़ंक्शन के बाद कोष्ठक जोड़ना या कहने से पहले कार्य करना है। फ़ंक्शन नाम और यदि फ़ंक्शन नाम के लिए स्वरूपण का उपयोग करके उपलब्ध है।


1
@gnat मैं यह नहीं पूछ रहा हूं कि किसी चीज का नाम क्या है, मैं पूछ रहा हूं कि फ़ंक्शन नाम के साथ वाक्य कैसे शुरू करें।
user3462295

13
गणित में एक संबंधित सम्मेलन है जिसे एक चर नाम या सूत्र के साथ एक वाक्य शुरू करने से बचना चाहिए। यह इस तथ्य के बावजूद है कि हमारे पास एक टाइपोग्राफिक सम्मेलन है जिसे चर और सूत्र पाठ से हटाने के लिए इटैलिक में प्रस्तुत किए जाते हैं। कोई लिखने से बचता है "Let x be a power of 2। X पॉजिटिव है, इसलिए ..." सामान्य फिक्स रीफ़्रेश करना है या कुछ फिलर शब्द जोड़ना है: "अब x पॉज़िटिव है" या "हमारे पास वह x पॉज़िटिव है" या किसी तरह का।
नैट एल्ड्रेडगे

9
एक प्रोग्रामिंग भाषा से एक पहचानकर्ता को एक विदेशी शब्द माना जाना चाहिए और अंग्रेजी के समान नियमों के अधीन नहीं होना चाहिए।
रफ़लविंड

1
अंग्रेजी पर कुछ उल्लेखनीय रूप से सक्रिय प्रोग्रामर हैं। ( tchrist ... इतना एरिक लिपर्ट नहीं ) - लेकिन यह आपके इच्छित उत्तर के प्रकार पर निर्भर करता है। हम इसे प्रोग्रामर केंद्रित साइट पर प्रोग्रामर के रूप में लिख रहे हैं। यदि आप तकनीकी लेखन, जर्नल दिशानिर्देशों और उचित अंग्रेजी वाक्य संरचना की औपचारिकताओं में अधिक रुचि रखते हैं, तो आप अपने लक्षित विशेषज्ञ दर्शकों पर पुनर्विचार करना चाह सकते हैं।

2
यह प्रश्न ऑफ़-टॉपिक प्रतीत होता है क्योंकि यह अंग्रेजी भाषा और उपयोग है, और हमारे पास इसके लिए संपूर्ण StackExchange साइट है। दरअसल, कम से कम चार ऐसे ही सवाल हैं । इसके अलावा, अलग-अलग उत्तर समान रूप से मान्य हो सकते हैं, जहां लेखन दिखाई देता है, आदि के आधार पर
कालेब

जवाबों:


87

टाइपोग्राफी में यह आम तौर पर एक अलग प्रतिपादन का उपयोग करके नियंत्रित किया जाता है, चाहे यह एक वाक्य की शुरुआत हो या न हो, यह इंगित करने के लिए कि आंख मारना क्या वाक्य में सिर्फ एक शब्द नहीं है बल्कि एक विशेष इकाई है।

आपका freadकार्यान्वयन टूट गया है। freadकितने बाइट्स पढ़ने के लिए वापस जाने की जरूरत थी।

एक दस्तावेज कितना औपचारिक है, इसके आधार पर, वह उसी दृष्टिकोण को अपना सकता है। किसी भी मामले में ऐसा करने से आपके द्वारा पहचाने गए मुद्दे को समाप्त कर दिया जाता है, इसलिए आप इसे केवल उसी कारण से उपयोग करने की इच्छा कर सकते हैं।

सादे पाठ की दुनिया में (जैसा कि टिप्पणियों और अन्य उत्तरों में कई द्वारा उल्लेख किया गया है), कोष्ठक को कार्य नामों में जोड़ना थोड़ा मदद करता है, लेकिन चूंकि हमें उन संस्थाओं का भी उल्लेख करना होगा जो कोष्ठक नहीं लेते हैं, इसका केवल सीमित मूल्य है। सामान्य तौर पर, सादे पाठ की दुनिया में ब्रैकेट्स और तारांकन जैसे विशेष वर्णों के साथ पाठ के आस-पास के एक सम्मेलन को अपनाने से छोटा विकल्प होता है, लेकिन वाक्य के पुनर्गठन से समस्या को दूर करने के लिए।


हाँ, मैं आपकी बात देख रहा हूँ, यह अभी भी अजीब है लेकिन कम अजीब है। हालांकि मैं समझता हूं कि भावनाओं को व्याकरण और लेखन के नियमों के साथ हमेशा इनलाइन नहीं किया जाता है। मुझे यकीन नहीं है कि अगर इसे संभालने का एक बेहतर तरीका है, तो मैं आपके जवाब को स्वीकार करूंगा जब तक कि कोई कुछ बेहतर नहीं करता।
user3462295

25
मैं अक्सर इस तरह की चीजों के लिए इटैलिकाइज करता हूं - आपको हमेशा केस-संवेदी शब्दों के आवरण को बनाए रखना चाहिए , चाहे वे किसी भी वाक्य में हों, आईएमओ। freadएक शब्द नहीं है; यह एक इकाई का प्रतिनिधित्व करने वाला एक प्रतीक है। यह व्याकरण के अधीन नहीं है।
एंट पी।

4
और ... सादे पाठ से निपटने के लिए आप क्या करते हैं? एक छोटी .Txt मदद फ़ाइल, या एक सादे पाठ ईमेल की तरह? मैं उस परिदृश्य के साथ-साथ आपके उत्तर का भी सुझाव देता हूं।
एलेसीडिल

2
@Ellesedil उस मामले में, मैं आमतौर पर इसके साथ प्रत्यय लगाऊंगा ()या (...)यह इंगित करने के लिए कि यह एक फ़ंक्शन है। लेकिन यह हमेशा काम नहीं करता है, खासकर जब चर और इस तरह के साथ काम करते हैं। फिर मैं `कोड को इंगित करने के लिए नाम (टिक चरित्र) के साथ लपेटता हूं ।
कोल जॉनसन

4
@Ellesedil मैंने कोड तत्वों को इंगित करने के लिए मार्कडाउन सिंटैक्स का उपयोग करने के लिए लिया है, यहां तक ​​कि टिप्पणियों जैसे सादे पाठ संदर्भों में भी। यह एकमात्र समय है जब मुझे सादे अंग्रेजी लिखते समय एक बैकटिक प्रतीक का उपयोग करने की आवश्यकता होती है।
कीन

53

यदि टोपी के साथ प्रत्येक वाक्य को शुरू करने की पूर्ण आवश्यकता है, तो बस fread" freadफ़ंक्शन" से प्रतिस्थापित करें जहां यह एक वाक्य शुरू होता है।


21

यदि आपके पास टाइपोग्राफिक साधन नहीं है, तो अंतर करें (दूसरे उत्तर के अनुसार), और हो सकता है कि आप भी करते हों, तो यह इंगित करना उपयोगी हो सकता है कि आप किसी फ़ंक्शन के बारे में बात कर रहे हैं:

आपका फ़्रेड () कार्यान्वयन टूट गया है। fread () को कितने बाइट्स पढ़े गए, उन्हें वापस करना होगा।

यह "समझा" कारण है कि यह दूसरे वाक्य की शुरुआत में बड़े अक्षरों में नहीं है के साथ मदद करता है, और भी मदद करता है (पहले वाक्य में) को समझने के लिए क्यों व्यक्तिवाचक संज्ञा (एक समारोह का नाम) वहाँ बड़े अक्षरों में नहीं है या तो । चूंकि (एक उचित संज्ञा के रूप में) यह यकीनन होना चाहिए था।

("यकीनन" क्योंकि हम तर्क दे सकते हैं कि क्या भय () एक सामान्य संज्ञा या एक उचित संज्ञा है)।

कुल मिलाकर, परेंस का उपयोग पाठक के मस्तिष्क को समझने में मदद करता है कि अजीब शब्द क्यों दिखाई देते हैं और वे क्या हैं।


5
Parens का उपयोग करना पाठ अतिरेक को कम करने में भी मदद करता है। "फ़ंक्शन फ़्रेड" के बजाय आप बस "फ़्रेड ()" कह सकते हैं। और यह भी उपयोगी है यदि आपके पास चर नाम और कार्यों जैसी चीजों के बीच अंतर पर जोर देने के लिए एक प्रकार का हाइलाइटिंग है।
1092 पर पॉल92

3
मुझे लगता है कि कोष्ठक केवल अधिक भ्रम जोड़ते हैं। fread()एक कॉल स्टेटमेंट हो सकता है। या यह कोई पैरामीटर के साथ एक अतिभारित समारोह का जिक्र किया जा सकता है।
केपेक्स

4
@kapep आम तौर पर कोड का उल्लेख करने वाले दस्तावेजों में, func_name()"नाम से एक फ़ंक्शन" के रूप में पढ़ा जाता है func_name, भले ही वास्तविक फ़ंक्शन में कोई भी पैरामीटर हो या न हो।
एरिक फिन

3
@ EricFinn मेरे अनुभव में यह आमतौर पर पैरामीटर रहित कार्यों को संदर्भित करता है, लेकिन यह भाषा और इसके सम्मेलनों पर निर्भर करता है। उदाहरण के लिए, आधिकारिक जावा टिप्पणी दिशानिर्देश कोष्ठक के उपयोग को हतोत्साहित करते हैं: "जब [एक विधि के विशिष्ट रूप] का उल्लेख करते हैं, तो कोष्ठक और तर्क प्रकारों का उपयोग करें। [...] हालांकि, यदि विधि के दोनों रूपों का उल्लेख करते हैं, तो छोड़ें। कोष्ठक पूरी तरह से। यह खाली कोष्ठकों को शामिल करने के लिए भ्रामक है, क्योंकि यह विधि का एक विशेष रूप होगा " oracle.com/technetwork/java/javase/documentation/…
kapex

3
दृश्य सुराग जोड़ना निश्चित रूप से एक अच्छा विचार है (सबसे अच्छा एक समर्पित फ़ॉन्ट या अन्यथा हाइलाइट है), मैं कप्पे के साथ सहमत हूं कि खाली parens को जोड़ना वास्तव में समस्याग्रस्त विकल्प है, क्योंकि मुझे पता f()है कि हर भाषा में कुछ अलग का मतलब है f। क्यों न कुछ उपयुक्त चरित्र के साथ नाम को घेर लिया जाए, उदाहरण के लिए मार्कडाउन-शैली `फ़्रेड` (यही वह है जो मैं वीसीएस प्रतिबद्ध संदेशों में करता हूं)? या बस (भय)। बेशक, ऐसी कोई भी चीज़ लगातार की जानी चाहिए, न कि केवल एक वाक्य की शुरुआत में कार्यों के लिए।
लेफ्टरनैबाउट

10

आप विवरण से वाक्य शुरू कर सकते हैं:

समारोह fread[…]

विधि fread[…]

संपत्ति breadColor[…]


@Zack: राष्ट्रपति ओबामा।
मार्क वैन लीउवेन

@MarcvanLeeuwen टाइटल एक विशेष मामला है। (इसके अलावा "क्वीन एलिजाबेथ", "मिस्टर रोजर्स"।) मेरे सिर के ऊपर से एक उचित विश्लेषण नहीं है, लेकिन सहजता से मुझे लगता है कि उन्हें श्रेणी टैग के बजाय नाम का हिस्सा माना जाता है।
zwol 14

8

आप प्रकाशनों में इनलाइन गणित की तुलना कर सकते हैं। आप बहुत कम ही वाक्यों को एक चर या अन्य इनलाइन गणित से शुरू करते देखेंगे।

इस प्रकार, मैं निष्कर्ष निकालता हूं, आपको एक वाक्य की शुरुआत में फ़ंक्शन नामों से बचना चाहिए।

शायद यह प्रश्न आगे का विवरण प्रदान करता है: क्या ग्रीक अक्षर (चर) के साथ एक वाक्य शुरू करना ठीक है?


3
+1। में गणितीय प्रमाणों (चर्त्रंद एट अल।, 2000), जिसका अध्याय 0 गणितीय लेखन के लिए अच्छी सलाह के एक सच्चे झरना है, के तहत पहले ही शासन प्रतीकों का उपयोग "कभी एक वाक्य एक प्रतीक के साथ शुरू करते हैं।" है (उदाहरण एक वाक्य है जो एक समीकरण के साथ शुरू होता है; लेखक इसे "द समीकरण ___" के साथ प्रीफ़ैस करने का सुझाव देता है।) हालांकि सभी गणितीय लेखन सलाह जरूरी नहीं कि स्रोत कोड के बारे में लेखन पर लागू हो, मुझे लगता है कि यह एक बिट है।
रुखाह

1
मुझे यकीन नहीं है कि मैं सादृश्य से सहमत हूं। $ X $ जैसे प्रतीक एक समीकरण के लिए क्षणिक होते हैं, इसलिए उनका उल्लेख करना अजीब है, क्योंकि उनका वैश्विक अर्थ है। अगर $ \ pi $ जैसा कोई प्रतीक वाक्य शुरू होता है, तो मैं एक पाठक के रूप में सहज महसूस करूंगा।
djechlin

1
@djechlin मुझे यकीन नहीं है कि प्रतीक के साथ एक वाक्य शुरू करने का मतलब है कि इसका वैश्विक अर्थ है, या वास्तव में इसके साथ कुछ भी करना है।
काइल स्ट्रैंड

@KyleStrand यह जानना अच्छा होगा कि आपको कभी भी एक प्रतीक के साथ एक वाक्य शुरू नहीं करना चाहिए। "$ \ pi $ है ..." v। "गणितीय स्थिर $ \ pi $ है ..." - आप चुनते हैं।
djechlin

1
@djechlin: एक कारण यह है कि यदि पिछला वाक्य गणित के साथ समाप्त होता है, तो निम्न वाक्य की शुरुआत में गणित बीच में एक डॉट के साथ एक ही सूत्र के भाग की तरह लग सकता है। (यह कॉमा के साथ एक समस्या का और भी अधिक है।) एक और मुद्दा यह है कि चूंकि चर नाम आमतौर पर कम मामले होते हैं, पाठक की आंख अगले वाक्य की शुरुआत खोजने के लिए एक बड़े अक्षर की तलाश के दृश्य क्यू खो देती है।
नैट एल्ड्रेडगे

3

फ़्रेड (3) के लिए लिनक्स मैन पेज जो दूसरों से जुड़ा हुआ है, चार सामान्य समाधानों का एक बड़ा उदाहरण है।

  1. "वाक्य फू" या "फू समारोह" के साथ अपना वाक्य शुरू करें। "फ़ंक्शन फ़्रेड को वापस लौटने की आवश्यकता है ..."
  2. अपने प्रोग्रामिंग भाषा समुदाय द्वारा उपयोग किए गए सम्मेलन के अनुसार अतिरिक्त पात्रों के साथ फ़ंक्शन नाम को चिह्नित करें। सी के मामले में, कोष्ठक की एक खाली जोड़ी है, इसलिए "फ़्रेड () को वापस जाने की आवश्यकता है ..."
  3. फ़ंक्शन नाम को हाइलाइट करने के लिए टाइपोग्राफ़ी (बोल्ड, निश्चित चौड़ाई वाले वर्ण या इटैलिक्स) का उपयोग करें: " फ़्रेड को लौटने की आवश्यकता है ..."
  4. सिस्टम पर जो उपयोग करते हैं man, यदि आपके फ़ंक्शन में एक मैन पेज है, तो कोष्ठक में मैनुअल के अध्याय को देखें। इसलिए "भय (3) को वापस आने की जरूरत है ..."

सभी चार दृष्टिकोण हैकर्स द्वारा तुरंत पहचानने योग्य होंगे, और आपको अपने घर की शैली या आपकी व्यक्तिगत आवाज से मेल खाने वाले को चुनने में सक्षम होना चाहिए।

जैसा कि आपने कहा, आप अपने फ़ंक्शन के नाम को उजागर करने के लिए टाइपोग्राफी पर भरोसा नहीं कर सकते। मार्कडाउन के सिंटैक्स को पठनीय प्रलेखन बनाने के लिए होता है, तब भी जब एक मार्कडाउन दुभाषिया अनुपलब्ध होता है, इसलिए सभी तरीकों से आपके फ़ंक्शन का नाम बैकटिक्स की एक जोड़ी से घिरा होता है। (यह है, मुझे लगता है, विकल्प 2 और 3 का संयोजन)

विकल्प 2 प्रोग्रामिंग भाषा के अनुसार भिन्न होता है। उदाहरण के लिए, रूबी और स्मॉलटॉक डॉक्स अक्सर #fread की तरह हैश के साथ इंस्टेंस विधि के नामों को पसंद करते हैं । इस बीच, लिस्पर्स फ़ंक्शन नाम को नंगे होना पसंद कर सकते हैं, लेकिन यह समझेंगे कि क्या आप एक कंकाल फ़ंक्शन कॉल लिखते हैं, जैसे कि (फ़्रेड ...) या (फ़्रेड) । आपके द्वारा प्रलेखित सभी भाषाओं के लिए कुल्ला और दोहराएं।


मुझे आपका जवाब पसंद है। ऐसा करने से कार्यों के बारे में लिखना बेहतर दिखता है।
user3462295

2

मैं केवल दिए गए विशिष्ट उदाहरण का उत्तर देने जा रहा हूं:

आपका फ़्रेड कार्यान्वयन टूट गया है। फ़्रेड को कितने बाइट्स पढ़ने के लिए वापस लौटना पड़ा।

बस पहले पूर्ण विराम (अवधि) को अर्धविराम से बदलें:

आपका फ़्रेड कार्यान्वयन टूट गया है; फ़्रेड को कितने बाइट्स पढ़ने के लिए वापस लौटना पड़ा।


3
नहीं! कि यह एक रन-ऑन वाक्य या अल्पविराम ब्याह होगा। बहुत घटिया व्याकरण। एक अर्धविराम ठीक होगा।
मार्टिन मैक्लेऑन

तो एक अल्पविराम का उपयोग हमेशा काम नहीं करता है; लेकिन अल्पविराम का उपयोग क्यों करें?
रीयरियरपोस्ट

यह अल्पविराम नहीं है। यह एक अर्धविराम है; उस पर अर्धविराम का उचित उपयोग।
रबरडक

1
मैं व्यक्तिगत रूप से एक अर्धविराम के बजाय यहाँ एक उपनिवेश का उपयोग करूँगा (हालाँकि यह एक अर्धविराम के साथ भी अच्छा है)।
मार्क वैन लीउवेन

0

मुझे पता है कि यह पहले ही उत्तर दिया जा चुका है, और स्वीकृत उत्तर बहुत अच्छा है, लेकिन मैं कुछ स्पष्ट करना चाहता हूं।

उचित अंग्रेजी व्याकरण में, निचली रेखा यह है: कभी-कभी उचित संज्ञाओं को ऐसे नाम दिए जाते हैं जो एक बड़े अक्षर से शुरू नहीं होते हैं, और ज्यादातर ऐसे मामलों में, वे हर बिट के रूप में संलग्न होते हैं जो "सामान्य" उचित संज्ञा के रूप में पूंजीकृत नहीं होते हैं। पूंजीकृत किया जा रहा है। ऐसे मामलों में - जिसमें निश्चित रूप से सी-अवरोही भाषाओं में अधिकांश फ़ंक्शन नाम शामिल होंगे - आप बिल्कुल एक वाक्य की शुरुआत में भी, नाम को कैपिटलाइज़ नहीं करते हैं । वास्तव में, यह ऐसा करने के लिए खराब अंग्रेजी व्याकरण और वर्तनी है। यह वास्तव में उसी सिद्धांत का एक हिस्सा है कि सोनी के गेमिंग कंसोल "PlayStation" को वर्तनी के लिए क्यों सही है, लेकिन "Playstation" नहीं।

ऐसे अन्य मामले हैं जिनमें एक उचित संज्ञा को डिफ़ॉल्ट रूप से पूंजीकृत नहीं माना जाता है, और फिर भी यह एक वाक्य की शुरुआत में उपयोग किया जा सकता है (और होना चाहिए)। ब्रेनफक भाषा का नाम इस का एक उदाहरण है। C- अवरोही भाषाओं में कार्य नहीं हैं। myFunc()और MyFunc()इस तरह की भाषाओं में दो पूरी तरह से अलग चीजें हैं, और "MyFunc ()" शब्द के साथ एक वाक्य शुरू करना केवल बाद वाले को संदर्भित करेगा, पूर्व को नहीं। VB.NET में हालांकि, यह एक ग्रे क्षेत्र है, क्योंकि ये दोनों कार्य उस भाषा में एक ही बात होगी, हालांकि फ़ंक्शन नाम उपयोगकर्ता-निर्दिष्ट पूंजीकरण योजनाओं को भी किसी न किसी स्तर पर बनाए रखेंगे।

इसके अलावा, भले ही इस मामले में अंग्रेजी नियम पत्थर में सेट किए गए हों, लेकिन वे एक नियम के रूप में इस तरह की चीजों के बारे में धुंधले हो जाते हैं। अंग्रेजी को इस तरह की चीजों के साथ डिजाइन नहीं किया गया था, इसलिए इस तरह की अन्य चीजों के लिए, कामचलाऊ व्यवस्था के लिए जगह है।

हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.