6

मैं सदस्य में इनलाइन दस्तावेज़ कैसे दस्तावेज़ कर सकता हूं? मुझे समझाने दो। टिप्पणियों से दस्तावेज निकालने वाले अधिकांश टूल कुछ प्रकार के इनलाइन दस्तावेज का समर्थन करते हैं जहां आप सदस्य घोषणा के बाद संक्षिप्त जोड़ सकते हैं। कुछ ऐसा:.NET में दस्तावेज़ सदस्यों को इनलाइन टिप्पणियों का उपयोग कैसे करें?

public static string MyField; /// <summary>Information about MyField.</summary> 

क्या सी # या .NET भाषाओं में ऐसा करने का कोई तरीका है?

उत्तर

6

नहीं, आप नहीं कर सकते हैं चाहता हूँ से पहले डाल दिया। एक्सएमएल टिप्पणियों को केवल ब्लॉक स्तर की टिप्पणी के रूप में समर्थित किया जाता है, जिसका अर्थ यह है कि इसे उस दस्तावेज़ तत्व से पहले रखा जाना चाहिए जिसे आप दस्तावेज कर रहे हैं। .NET कोड से एक्सएमएल टिप्पणियों को निकालने के लिए सामान्य उपकरण समझ में नहीं आते हैं कि इनलाइन टिप्पणियों को कैसे पार्स करना है। अगर आपको इस क्षमता की ज़रूरत है तो आपको अपना खुद का पार्सर लिखना होगा।

+0

डॉक्सीजन इसका समर्थन करता है, इसलिए आपको अपना खुद का पार्सर लिखने की आवश्यकता नहीं है। –

1

हाँ, बस यह बात आप टिप्पणी करने के लिए

/// <summary>Information about MyField.</summary> 
public static string MyField; 
+0

मुझे पता है कि मैं इसे पहले रख सकता हूं। मैं पूछ रहा हूं कि क्या मैं इसे उसी पंक्ति में रख सकता हूं। – Curro

+0

यह एक इनलाइन टिप्पणी नहीं है। –

+0

// मल्टीलाइन के विपरीत/* के विपरीत एक इनलाइन टिप्पणी निर्दिष्ट करता है, यही वह है जो मैंने सोचा था। नहीं, इसके बाद इसे डालने का कोई तरीका नहीं है। संकलक को कैसे पता चलेगा कि आप इसे निम्न पंक्ति पर लागू नहीं करना चाहते थे? – GeekyMonkey

2

ऐसा करने का एक अंतर्निहित तरीका नहीं है। एक्सएमएल दस्तावेज प्रणाली पदानुक्रमित है; यह टैग <summary /> और उस डेटा के बीच संबंध को परिभाषित करता है जो तुरंत इसका अनुसरण करता है।