क्या पहले व्यक्ति टिप्पणी विचलित और अव्यवसायिक हैं?

Question

मैंने अपने आप को कुछ (पुरातन विज़ुअल बेसिक 6.0) कोड में निम्नलिखित टिप्पणी लिखते हुए पाया: मैं लिख रहा था:

If WindowState <> 1 Then
    'The form's not minimized, so we can resize it safely
    '...
End if

मुझे यकीन नहीं है कि मैं अपनी टिप्पणियों में "हम" का उपयोग क्यों कर रहा हूं। मुझे संदेह है क्योंकि मुझे लगता है कि कोई व्यक्ति कोड के माध्यम से कदम रख रहा है, जैसे कि वे वास्तव में प्रत्येक पंक्ति पर सभी आदेशों को "कर" रहे हैं, बजाय कि उन्हें देखे हुए। इस मानसिकता के साथ, मैं इस्तेमाल कर सकता था I can resize it, क्योंकि मैं इस समय "एक" कर रहा हूं, या you can resize it, जैसे कि मैं जिसे बोल रहा था वह भविष्य में "कर" रहा है, लेकिन चूंकि इन दोनों मामलों में सबसे अधिक संभावना है ऐसा होता है, मैं "हम" का उपयोग करता हूं जैसे कि मैं अपने कोड के माध्यम से किसी और का नेतृत्व कर रहा हूं।

मैं बस इसे फिर से लिख सकता हूं it can be resizedऔर इस मुद्दे से बच सकता हूं, लेकिन इसने मेरी जिज्ञासा को जगा दिया: क्या इस तरह के पहले व्यक्ति को टिप्पणियों में इस्तेमाल करना आम है, या इसे विचलित करने वाला और / या अप्रमाणिक माना जाता है?

Comments

चढ़ाव के लिए टिप्पणियाँ? यह मेरा पहला Programmers.SE प्रश्न है, और मैं अभी भी यह पता लगाने की कोशिश कर रहा हूं कि एक अच्छा P.SE प्रश्न बनाम एक अच्छा SO प्रश्न क्या है।

— dlras2

मैंने आपको निराश नहीं किया, लेकिन मैं यह अनुमान लगा सकता था कि वे शीर्षक प्रश्न पसंद नहीं करते थे, क्योंकि इसके उत्तर आसानी से संक्षिप्त, गपशप के रूप में हो सकते हैं, और उलटे राय के लिए दिए जा सकते हैं। रिकॉर्डिंग जो आपके अंतिम प्रश्न की तरह अधिक हो सकती है।

— DKnight जूल

मुझे 'हम ’पसंद है। एक तरह से, विविध तरह से अपने अनुकूल और समावेशी।

— जेरेमी

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

— DKnight

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

— माइकल बूर

Answer 1

मनुष्य को समझने के लिए टिप्पणियाँ लिखी जानी चाहिए। जब मनुष्य संवाद करते हैं, तो हम आम तौर पर "I", "हम", "आप" आदि का उपयोग करते हैं।

जब कोई व्यक्ति किसी कोड को समझने की कोशिश कर रहा होता है, तो दो या दो से अधिक कलाकार होते हैं: इसे पढ़ने वाला व्यक्ति और कोड का मूल लेखक। "हम" कहना ठीक है। जब तक 'पेशेवर' से आपका मतलब 'रोबोट जैसा' नहीं है।

Comments

+1 इस तरह से लिखने से आपको संभावित पाठक पर विचार करने के लिए लेखक को प्रोत्साहित किया जा सकता है और यह वास्तव में उन अवधारणाओं को देखने में मदद कर सकता है जिन पर बेहतर व्याख्या करने की आवश्यकता हो सकती है।

— जस्टिन ओम्स

// we approve of this answer:)

— जारोद डिक्सन

+1 और एक प्रवर्धन: कॉन्ट्रिवाइज़, पैसिव-वॉयस कंस्ट्रक्शन जैसे "इसे रीसाइज़ किया जा सकता है" को लिखित रूप में अस्वीकार कर दिया जाता है क्योंकि हम उन्हें समझना मुश्किल समझते हैं। यदि आप निष्क्रिय-ध्वनि का उपयोग करते हैं तो आप अपने पाठक को वाक्य के लिए एक विषय का आविष्कार करने और याद रखने के लिए मजबूर करते हैं।

— msw

@msw: क्या हमें '' इसे फिर से आकार दिया जा सकता है '' जैसे निष्क्रिय-ध्वनि निर्माण को अस्वीकार करना चाहिए ...?

— tdammers

@msw, रूसी में, उदाहरण के लिए, निष्क्रिय आवाज निर्माण अधिक सामान्य हैं और कुछ सांस्कृतिक मतभेदों के कारण अधिक आसानी से समझे जाते हैं। (और नहीं, मैंने उस वाक्य को निष्क्रिय आवाज में नहीं लिखा है!)

— पी शेव्ड

Answer 2

मैं 'I' का उपयोग करने से दूर रहने का सुझाव दूंगा क्योंकि यह कोड के लिए स्वचालित रूप से सभी जिम्मेदारी लेता है। यदि अन्य लोग इसे पढ़ रहे हैं, तो यह बुरा लगेगा क्योंकि यह इस मामले में एक टीम प्रयास होने के लिए है। मैं 'हम' का उपयोग करने के बारे में उदासीन हूं। हालाँकि, यह अन्य पाठकों के साथ अनजाने में शामिल हो सकता है।

मेरा वोट अभी भी संक्षिप्तता और संक्षिप्तता के लिए जाता है। यदि संदेश को कम-क्रियात्मक तरीके से व्यक्त किया जा सकता है, तो कुछ और क्यों चुनें? इसलिए, इस उदाहरण के बारे में, मैं लिखूंगा:

'The form is not minimized so it can be resized safely.

Comments

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

— जोनाथन हेंसन

टीम सेटिंग में सभी जिम्मेदारी नहीं संभालने के लिए +1। और जब मैं क्रियात्मक टिप्पणियों से बचने की कोशिश करने के बारे में सहमत हूं, तो कभी-कभी निष्क्रिय तनाव को पढ़ने के लिए और भी कठिन हो सकता है (जैसा कि जेकेजे ने बताया है) और कोई कम क्रिया नहीं है, और मैं मोटापे से बचना पसंद करता हूं। =]

— dlras2

@ जोनाथन हेंसन: कई टिप्पणियाँ अच्छी हैं, लेकिन केवल तभी जब उनमें बहुत सारी उपयोगी जानकारी हो। यदि समान जानकारी को दो समकक्ष तरीकों से व्यक्त किया जा सकता है, तो छोटी एक बेहतर है।

— tdammers

मेरी सलाह है कि निष्क्रिय आवाज का उपयोग करने से बचें। यह समझना अधिक कठिन है, खासकर गैर-देशी अंग्रेजी बोलने वालों के लिए।

— विले लॉरिकारी

Answer 3

मैं दो दृष्टिकोणों में से एक लेता हूं, आमतौर पर जो भी बेहतर लगता है।

आवश्यकताओं या औचित्य जैसी चीजों को समझाने में, मैं आपके साथ "हम" के रूप में जाता हूं:

// We can't proceed unless the user has given us this information.

यदि मैं प्रक्रिया की व्याख्या कर रहा हूं, तो मैं एक अनिवार्य (कमांड) आवाज का उपयोग करता हूं (सही होने पर मुझे गलत शब्द बताएं):

// Get the foo from bar and make sure it follows our required format.

उत्तरार्द्ध कोड को दोहराने के लिए खतरनाक रूप से करीब हो सकता है, लेकिन उपयोग हैं। तो यह आई या हम का उपयोग नहीं कर रहा है, लेकिन इसके बजाय यह वास्तव में "आप" का अर्थ है।

Comments

बिल्कुल यही मेरा स्टाइल भी है। आपके द्वारा वर्णित दोनों तरीकों का अपना स्थान है।

— ज़ोर्तनी

उत्तरार्द्ध में "हमारा" भी है। मुझे यह दिलचस्प लगता है कि लोग स्वाभाविक रूप से प्रथम-व्यक्ति बहुवचन में टिप्पणियां लिखते हैं।

— रीड

@ वाह वाह, जो सिर्फ वृत्ति थी, मैंने भी ध्यान नहीं दिया। लेकिन यह आसानी से "द" कहा जा सकता था।

— Tesserex

Answer 4

मुझे लगता है कि यह अकादमिक / तकनीकी लेखन शैली पर सिर्फ एक भिन्नता है, जो अक्सर अवैयक्तिक होती है। निष्क्रिय आवाज़ का उपयोग करके, "शाही हम" ("एक" इतना दिनांकित है) का उपयोग कर।

एक सामान्य नियम के रूप में, यह है गैर विशिष्ट है जो इसे वैसे भी उपयोग करेगा - देखरेख लाभ के लिए टिप्पणी है, नहीं सामान्य रूप से सिर्फ मूल लेखक के लिए।

उस ने कहा, मैं पहले व्यक्ति का उपयोग टिप्पणियों में अक्सर करता हूं - यह समझाने के लिए कि मैंने विशेष निर्णय क्यों लिए , और मैं क्या सोच रहा था।

Comments

मुझे व्यक्तिगत रूप से यह नहीं लगता कि "एक" दिनांकित है। हां, यह कम आम उपयोग में है, क्योंकि यह कुछ ऐसा नहीं है जो समय-समय पर उपयोग करता है। हालाँकि, शून्य से कम संभावना है कि किसी टिप्पणी के अर्थ में "एक" का उपयोग करना अपठनीय है या अन्यथा प्रयोज्य से अलग हो जाएगा।

— बिली ओनेल

Answer 5

टिप्पणियां आपको बताएं कि कुछ क्यों किया जा रहा है, न कि क्या किया जा रहा है। यदि जो किया जा रहा है वह कोड से स्पष्ट नहीं है, तो कोड को ठीक करें, केवल टिप्पणी न जोड़ें। प्रथम-व्यक्ति, द्वितीय-व्यक्ति आदि, कोई फर्क नहीं पड़ता है, जो आवश्यक जानकारी संचारित कर रहा है।

यदि आपको कोड बताना चाहिए, तो अनिवार्यता पसंद करें, जैसे

'ensure that the window is not minimized
If WindowState <> 1 Then
    'resize the window
    '...
End if

(और कृपया कोड में "1" जैसे नंगे स्थिरांक का उपयोग न करें)

Comments

+1 अनिवार्य करने के लिए, मैंने ऐसा नहीं सोचा था। इसके अलावा, हां, मुझे नंगे का इस्तेमाल नहीं करना चाहिए था 1। मैं आमतौर पर उस बारे में बहुत अच्छा हूँ ... यह मेरे लिए छोड़ दो कुछ समय के लिए यह मेरा दिमाग इंटरनेट पर फिसल गया।

— dlras2

Answer 6

हो सकता है कि हम कार्यक्रम के अंदर छोटे लोगों का जिक्र कर रहे हों जिससे जादू हो जाए? :)

अंग्रेजी भाषा निष्क्रिय आवाज का उपयोग करना कठिन है और बुरा लगता है। लोग व्यक्ति के रूपों का उपयोग करना पसंद करते हैं (मैं, आप, हम, एक)।

उदाहरण:

(आपको (हमें / एक को) माता-पिता को घटनाओं का आकार बदलने के लिए एक प्रतिनिधि का उपयोग करना चाहिए

अभिभावक को घटनाओं का आकार बदलने के लिए एक प्रतिनिधि का उपयोग करना पड़ता है

एक और उदाहरण (ध्यान दें कि आप अक्सर टिप्पणियों में व्यक्ति के रूपों को छोड़ सकते हैं):

(हमने) एक अपवाद पकड़ा। (हम होंगे) एक त्रुटि संवाद दिखा रहा है।

एक अपवाद पकड़ा गया और एक त्रुटि संवाद दिखाया जाएगा।

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

Comments

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

— इंका

Answer 7

यदि आप कार्यक्रम के निष्पादन के बारे में बात कर रहे हैं, तो यह 'हम', 'आप' या 'मैं' नहीं है। एंथ्रोपोमोर्फिज्म इतना व्यापक हो सकता है कि किसी का ध्यान नहीं जा सकता है लेकिन यह एक खतरनाक आदत है (पीडीएफ चेतावनी। डायजस्ट्रा चेतावनी।)।

मुझे लगता है कि मानवविज्ञान सबसे बुरा है। मैंने अब कार्यक्रमों को "चीजों को करने की कोशिश", "चीजों को करने की इच्छा", "चीजों को सच मानने के लिए", "चीजों को जानने" आदि को देखा है, इतना भोले मत बनो कि भाषा का यह उपयोग हानिरहित हो। यह प्रोग्रामर को कार्यक्रम के निष्पादन के साथ खुद को पहचानने के लिए आमंत्रित करता है और लगभग उस पर परिचालन शब्दार्थ का उपयोग करता है।

Comments

दिक्जस्त्र चेतावनी! यदि केवल अधिक चीजों में एक था :(

— टॉम एंडरसन

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

— Blujay

Answer 8

मुझे नहीं लगता कि पहले व्यक्ति या "शाही हम" अव्यवसायिक हैं, या विचलित करने वाले हैं। मुझे लगता है कि हमें ई-प्राइम में अंग्रेजी-भाषा की टिप्पणियों को लिखने का प्रयास करना चाहिए , अंग्रेजी का सबसेट जो "होने" के लिए क्रिया नहीं है।

यदि आप टिप्पणियों में "होना" का अधिक उपयोग करते हैं, तो आपको भ्रमित करने वाले कथन मिलते हैं:

// X is 10
// X is the user data of the newly-authenticated user
// X is a BigInt

ठीक है, हो सकता है कि एक बार में ही नहीं, लेकिन समता-समानता वास्तव में टिप्पणियों को अस्पष्ट बना सकती है।

मुझे लगता है कि ई-प्राइम में लेखन आवश्यकताएं उन आवश्यकताओं को स्पष्ट करने में मदद करती हैं, क्योंकि लेखक को कार्रवाई के साथ एक अभिनेता का संकेत देना चाहिए।

Comments

दिलचस्प धारणा; "एक्स कम से कम 5" होना चाहिए या "वाई 23 से अधिक नहीं होना चाहिए" की धारणा को कैसे व्यक्त करेगा?

— सुपरकाट

@ सुपरकैट - "X के मान में 5 या उससे अधिक का परिमाण होना चाहिए"। "Y का मान 23 से अधिक नहीं होना चाहिए"। समानता, तार्किक या अंकगणित, "होने के लिए" क्रिया का उपयोग नहीं करना चाहिए। "X में 5" होना चाहिए, या "X 5 का मूल्यांकन करता है" या "X का मान 5 है" या सोमेसिक है। यदि आप एक विशेष रूप से अस्पष्ट टिप्पणी पर आते हैं, तो "होने के लिए" क्रियाएं देखें। मैं शर्त लगाता हूं कि अस्पष्ट टिप्पणी नोटिंग का उपयोग करती है लेकिन "होने" के लिए। यह भी ध्यान दें कि मैंने उत्तर ई-प्राइम में ऊपर लिखा था।

— ब्रूस एडगर

दूसरा ठीक है; पहला ऐसा नहीं है, क्योंकि -6 में 5 या उससे अधिक का परिमाण है।

— सुपरकाट

@ सुपरपैक्ट - बहुत अच्छी तरह से। "X में 5 या अधिक का एक पूर्णांक पूर्णांक मान होना चाहिए"। अमेरिका में, हम आपके "परिमाण" को "पूर्ण मूल्य" कहेंगे, जो कि चर के मूल्य का वर्णन करने के मेरे बिंदु को पुष्ट करता है, न कि चर-के-मूल्य को, जो कि समता-समानता से उत्पन्न होता है।

— ब्रूस एडिगर

Answer 9

टिप्पणी करने के लिए सही शैली तीसरा व्यक्ति अवैयक्तिक है; " फ़ॉर्म को कम से कम नहीं किया गया है, इसलिए इसे सुरक्षित रूप से आकार दिया जा सकता है "।

• मैं भोली हूँ।
• आप क्रैस हैं।
• हम बहुत औपचारिक (और शाही) हैं।

प्रत्येक वाक्य को इस तरह से रीफ़्रेश किया जा सकता है (ऊपर देखें) और यह लिखने का एकमात्र पेशेवर तरीका है।

Comments

-1 क्योंकि: कोई सही तरीका नहीं है, मैं I / You / हम आपके संपर्क से थोड़ा बाहर निकलता हूं और मुझे अंतिम भाग समझ में नहीं आता है। एक तरफ: जब मैं अपनी टिप्पणियों में "हम" कहता हूं, तो मैं एक राजा की तरह बात करने की कोशिश नहीं कर रहा हूं - मैं आपसे बात कर रहा हूं, लड़का मेरे कोड को पढ़ रहा है, और मेरे विचारों के साथ-साथ चल रहा है।

— doppelgreener

Answer 10

यह टिप्पणी पर निर्भर करता है।

आमतौर पर, मैं द माउथ ऑफ़ ए काउ द्वारा सुझाए गए तरीके से टिप्पणियां लिखता हूं । मैं हमेशा इस तरीके से डॉक्यूमेंटेशन-जनरेटिंग कमेंट्स (Doxygen, JavaDoc) भी लिखता हूं।

हालाँकि, कई बार स्रोत फ़ाइलों में लिखी / छुआ गई लाइनों को पहचानने के लिए संस्करण नियंत्रण के उपयोग की उपेक्षा करते हैं। ऐसे समय होते हैं जब "I" कहना उचित होता है, खासकर जब कोड लिखने वाले व्यक्ति को "I" को ट्रैक करना काफी आसान होता है। यदि आप एक व्यक्ति के रूप में, एक निर्णय लेते हैं, तो मैं कोड के साथ-साथ लाइन में निर्णयों को पहचानने और ट्रैक करने के लिए "I" (संस्करण नियंत्रण के साथ) का उपयोग करने की सलाह देता हूं।

Comments

Doxygen और JavaDoc के लिए +1। मैं मानता हूं कि प्रलेखन टिप्पणियों से अलग है, (हालांकि कुछ टिप्पणियां प्रलेखन उत्पन्न करती हैं), और मैं इस तरह के प्रलेखन को मेरी टिप्पणी से एक कदम अधिक औपचारिक रखने के लिए अपनी पूरी कोशिश करता हूं।

— dlras2 2

Answer 11

मेरे अच्छे बूढ़े पिता (mhrip) पूछेंगे: "क्या आपके पास परेशान करने के लिए अधिक महत्वपूर्ण चीजें नहीं हैं?"

हालांकि, व्यक्तिगत रूप से, मुझे "हम" पसंद है। और मैं खुद को यह भी सोचता हुआ पाता हूं कि मैं हमें अप-स्ट्रीम दस्तावेजों में क्यों लिखता हूं, कोड भी नहीं, यह विचार करते हुए कि मैं अपनी कंपनी का एकमात्र कर्मचारी हूं।

हालाँकि, मैं और मैं इस बात से सहमत हैं कि इस तरह से हम कम अकेला महसूस करते हैं :)

Answer 12

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

Answer 13

छोटी टिप्पणियों के लिए, मैं कभी-कभी दूसरे व्यक्ति में लिखता हूं, जैसे कि मैं किसी और को निर्देश दे रहा हूं, लगभग एक संदेश के रूप में अगले डेवलपर को टिप्पणी पढ़ने के लिए निर्देशित किया गया है। जैसे कि

//You can get a session_id from SYSSession.getSessionID() if you need one

लम्बी टिप्पणियाँ (जैसे कि एक लंबी फ़ंक्शन हेडर या एल्गोरिथम विवरण की कई पंक्तियाँ) मैं तटस्थ, कोई प्रथम-व्यक्ति, द्वितीय-व्यक्ति या तृतीय-व्यक्ति रखने का प्रयास करता हूं।

Comments

अंग्रेजी निष्क्रिय शायद ही कभी अच्छा लगता है: "एक session_id SYSSession.getSessionID () से प्राप्त किया जा सकता है अगर एक की जरूरत है"

— jkj

Answer 14

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

एक अच्छी तरह से नामित विधि, हालांकि छोटा है, एक टिप्पणी धड़कता है, क्योंकि यह टिप्पणियों और कोड के लिए सिंक से बाहर होना आसान है।

इसलिए, यदि अधिकांश टिप्पणियों को कोड में व्यक्त किया जा सकता है, तो वह टिप्पणियों के लिए बहुत कम कारण छोड़ता है

• यदि आपकी टिप्पणी आपकी राय है, तो "I" से शुरू करें
• यदि आपको लगता है कि आपकी टिप्पणी एक साझा राय (उदाहरण के लिए एक सर्वोत्तम अभ्यास) होनी चाहिए, तो "हम" से शुरू करें
• यदि आपकी टिप्पणी को अर्ध-बुद्धि द्वारा लिखे गए कुछ डोडी कोड पर निर्देशित किया गया है, तो टिप्पणी को स्क्रैप करें और एक सहकर्मी से भ्रमित करने वाले कोड को दबा दें और फिर उनके साथ इस फेस-टू-फेस को संबोधित करें।

Comments

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

— dlras2

वरीयता। मैं function() { return this.windowState != 1 }किसी भी टिप्पणी की तरह एक निजी बूलियन विधि लेता हूं । +1 मुझसे

— किपला

@ क्या, अगर किसी और के साथ बाद में आता है: क्यों वे चारों ओर खोज करते हैं और एक खिड़की को कम से कम किया जा सकता है यह निर्धारित करने के लिए तर्क को फिर से पता लगाते हैं? हो सकता है कि वे आपकी छोटी लाइन कोड की एक टिप्पणी के साथ भी हाजिर न हों और खुद को जोड़ लें। अब आपको 2 स्थान मिल गए हैं जिन्हें बदलने की आवश्यकता है यदि तर्क बदल जाए और 2 स्थान जहां टिप्पणियाँ कोड के साथ सिंक से बाहर हो सकती हैं। एक अच्छी तरह से नामित 1 लाइन विधि (जो राज्य को नहीं बदलती है) ने जटिलता को जोड़ा है? यह सबसे सरल और सबसे साफ रिफ्लेक्टर में से एक है।

— स्टीव डन

Answer 15

अंगूठे के एक नियम के रूप में, मेरा सुझाव है कि पहले व्यक्ति का उपयोग करें, अर्थात I।

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

Answer 16

व्यक्तिगत रूप से मैं लिखूंगा (C # में):

if (WindowState != WindowState.Minimised)
{
     ResizeWindowSafely();
}

या उन पंक्तियों के साथ कुछ, इस प्रकार टिप्पणियों की आवश्यकता नहीं है।

Comments

ResizeWindowSafelyइसका मतलब यह हो सकता है कि अगर आप यह नहीं जानते कि आकार बदलना है या नहीं, और इस तरह if (WindowState != WindowState.Minimised)खुद को शामिल करना होगा ।

— dlras2