8
मैं एक मनमाना जवाब की तलाश में हूं, इसलिए यह एक और चर्चा हो सकती है। मैं सोच रहा हूं कि दृश्य स्टूडियो में मेरे सी # कोड पर टिप्पणी करने का सबसे अच्छा अभ्यास क्या है। फिलहाल मैं एक्सएमएल उत्पन्न करने के लिए ट्रिपल /// का उपयोग कर रहा हूं और एक सीएम या एचटीएमएल फाइल बनाने के लिए रेत महल का उपयोग कर रहा हूं।टिप्पणी कोड सी # दृश्य स्टूडियो सर्वोत्तम अभ्यास
- अन्य डेवलपर्स मेरी कोड का उपयोग कर रहे हैं वे प्रलेखन, दोनों Intellisence और chm पढ़ सकते हैं: लेकिन मेरी समस्या यह है कि मैं दो कारणों के लिए कोड टिप्पणियों का उपयोग है। या एचटीएमएल फ़ाइल।
- लेकिन मैं खुद को अनुस्मारक के रूप में टिप्पणी का उपयोग भी करता हूं। इसलिए जब मैं आधे साल बाद कुछ जटिल तरीकों से वापस आ जाता हूं तो मैं अपने विचारों को याद कर सकता हूं।
दोनों लक्ष्यों को एक-दूसरे के साथ हस्तक्षेप किए बिना कैसे पूरा किया जा सकता है, और साथ ही साथ एक त्वरित कार्य हो सकता है, बहुत सारे कोडिंग समय नहीं लेते?
उत्तर के लिए धन्यवाद। मुझे लगता है कि हम सभी को द्विआधारी समस्या है जिसे हमें अपने काम के लिए भुगतान मिलता है, इसलिए हमें अच्छा कोड बनाना है और इसे लिखने में बहुत अधिक घंटे का उपयोग नहीं करना है। कभी-कभी टिप्पणियों को इसके लिए त्वरित और गंदे फिक्स के रूप में उपयोग किया जा सकता है। और मुझे पता है कि यह सबसे अच्छा अभ्यास नहीं है :) – DNRN
मैं आपसे सहमत हूं। अच्छी गुणवत्ता और अर्थशास्त्र के बीच हमेशा एक व्यापार बंद है। मैं निश्चित रूप से टिप्पणियां लिखता हूं जैसे "// TODO: इस पर प्रतिक्रिया करने के लिए मत भूलना" या "// हैक: बाद में ठीक करें" :-) बेशक यह प्रोजेक्ट के प्रकार पर निर्भर करता है, लेकिन मुझे अक्सर खुद को कोड लिखना पड़ता है कई सालों तक (अक्सर मेरे अलावा अन्य लोगों द्वारा) बनाए रखा जाना चाहिए और उस स्थिति में जब मैं इसे लिखने में अतिरिक्त देखभाल करता हूं तो यह वास्तव में लंबे समय तक भुगतान करता है। प्रोटोटाइप लिखते समय मैं बहुत कम ध्यान देता हूं। – Steven
@ डीएनआरएन: अर्थशास्त्र की बात करते हुए, क्या आपने "तकनीकी ऋण" की अवधारणा के बारे में सुना है?विचार यह है कि यदि आप बाद की तारीख के लिए रिफैक्टरिंग बंद कर देते हैं, तो आप वास्तव में तकनीकी ऋण प्राप्त कर रहे हैं जिसे भविष्य में ब्याज के साथ भुगतान करना होगा। इस मामले में रुचि याद रखने का उपर है कि कोड क्या करता है। इसके बजाए, मैं एक गुणवत्ता रिफैक्टरिंग टूल की सिफारिश करता हूं, जैसे रीशेपर या कोडरश जो बेहद कुशल रीफैक्टरिंग का काम करता है। इस तरह के एक उपकरण का उपयोग करके, आप दोनों दुनिया के सर्वश्रेष्ठ ... अब अतिरिक्त समय के बिना refactor मिलता है। –