मैं ठीक से प्रलेखित कोड का प्रस्तावक हूं, और मैं इसके संभावित डाउनसाइड्स से अच्छी तरह वाकिफ हूं । यह इस सवाल के दायरे से बाहर है।
मैं हर सार्वजनिक सदस्य के लिए XML टिप्पणियों को जोड़ने के नियम का पालन करना पसंद करता हूं , यह देखते हुए कि मुझे Visual Studio में IntelliSense कितना पसंद है।
हालांकि अतिरेक का एक रूप है, जो मेरे जैसे अत्यधिक टिप्पणी करने वाले से भी परेशान है। एक उदाहरण के रूप में List.Exists () लें ।
/// <summary>
/// Determines whether the List<T> contains elements
/// that match the conditions defined by the specified predicate.
/// </summary>
/// <returns>
/// true if the List<T> contains one or more elements that match the
/// conditions defined by the specified predicate; otherwise, false.
/// </returns>
public bool Exists( Predicate<T> match )
{
...
}
Summaryऔर returnsमूल रूप से एक ही बात कह रहे हैं। मैं अक्सर सारांश को एक returnsपरिप्रेक्ष्य से अधिक लिखना समाप्त करता हूं, returnsप्रलेखन को पूरी तरह से छोड़ देता हूं ।
जब सूची में ऐसे तत्व होते हैं जो निर्दिष्ट प्रेडिकेटेट द्वारा परिभाषित शर्तों से मेल खाते हैं, तो सही है, अन्यथा गलत है।
इसके अतिरिक्त, इंटेलीजेंसी में रिटर्न प्रलेखन नहीं दिखता है, इसलिए मैं तुरंत किसी भी प्रासंगिक जानकारी को लिखता हूं summary।
- आपको कभी भी
returnsअलग से दस्तावेज़ करने की आवश्यकता क्यों होगीsummary? - Microsoft ने इस मानक को क्यों अपनाया इस पर कोई जानकारी?