13
शीर्षक यह सब कुछ कहता है। मैं अपनी एक्सएमएल टिप्पणियां कहां लागू करूं? क्या मुझे इंटरफ़ेस में एक अधिक सामान्य XML टिप्पणी और कार्यान्वयन कक्षा पर एक और वर्णनात्मक रखना चाहिए? इस तरह:क्या आपको इंटरफेस, कंक्रीट कार्यान्वयन या दोनों के लिए एक्सएमएल टिप्पणियां लिखनी चाहिए?
public interface IObjectRepository
{
/// <summary>
/// Returns an object from the respository that contains the specified ID.
/// </summary>
Object GetObject(int Id);
}
public ObjectRepository : IObjectRepository
{
/// <summary>
/// Retrieves an object from the database that contains the specified ID.
/// </summary>
public Object GetObject(int Id)
{
Object myData = // Get from DB code.
return myData;
}
}
मैं सादगी की खातिर <param> शामिल नहीं किया।
क्या यह टिप्पणियों के लिए एक अच्छा अभ्यास है या क्या कोई अलग तरीका है? क्या मैं सिर्फ इंटरफ़ेस पर टिप्पणी छोड़ रहा हूं? किसी भी मदद की सराहना की है।
संभव डुप्लिकेट (http://stackoverflow.com/questions/759703/comment-the-interface-implementation-or-both) –
संभव डुप्लिकेट [इंटरफ़ेस, कार्यान्वयन या दोनों पर टिप्पणी करें?] (https://stackoverflow.com/questions/759703/comment-the-interface-implementation-or-both) – Olly
lol यह प्रश्न यहां छह साल तक रहा है। बहुत ऊब गया? – Chev