मुझे मिलने वाली प्रतिक्रिया के आधार पर, मैं अपने सहयोगियों के साथ यह "मानक" बढ़ा सकता हूं। यह कस्टम स्टाइलकॉप नियम बन सकता है। क्या पहले से ही एक लिखा है?क्या .net टिप्पणियां पूंजी पत्र से शुरू होनी चाहिए और अवधि के साथ समाप्त होनी चाहिए?
तो, स्टाइलकॉप पहले ही summary, param, और return दस्तावेज़ टैग के लिए इसे निर्देशित करता है।
क्या आपको लगता है कि टिप्पणियों से इसकी मांग करना समझ में आता है?
संबंधित नोट पर: यदि कोई टिप्पणी पहले से ही लंबी है, तो इसे उचित वाक्य के रूप में लिखा जाना चाहिए?
उदाहरण के लिए (शायद मैं एक बुरा टिप्पणी वर्णन करने के लिए भी बहुत कोशिश की):
//if exception quit
बनाम
// If an exception occurred, then quit.
लगा है - समय की सबसे, एक एक टिप्पणी लिखने हेतु परेशान करता है, तो , तो यह जानकारीपूर्ण भी हो सकता है। इन दो नमूनों पर विचार करें:
//if exception quit
if (exc != null)
{
Application.Exit(-1);
}
और
// If an exception occurred, then quit.
if (exc != null)
{
Application.Exit(-1);
}
बेशक, एक एक टिप्पणी बिल्कुल जरूरत नहीं है, लेकिन एक के बाद से प्रदान की जाती है, मुझे लगता है कि एक दूसरे के लिए बेहतर है लगता होगा।
कृपया अपनी राय का बैक अप लें। क्या आपके पास टिप्पणी की कला के लिए अच्छा संदर्भ है, खासकर यदि यह .NET से संबंधित है?
धन्यवाद।
व्यक्तिगत रूप से मैं उन प्रकार की टिप्पणियों को कोड ब्लॉक में डाल दूंगा ताकि यदि कोई मौजूद हो तो आप अन्य स्थिति के लिए टिप्पणी कर सकते हैं। –