विषयसूची:

मैं विजुअल स्टूडियो में एक्सएमएल में टिप्पणियां कैसे जोड़ूं?
मैं विजुअल स्टूडियो में एक्सएमएल में टिप्पणियां कैसे जोड़ूं?

वीडियो: मैं विजुअल स्टूडियो में एक्सएमएल में टिप्पणियां कैसे जोड़ूं?

वीडियो: मैं विजुअल स्टूडियो में एक्सएमएल में टिप्पणियां कैसे जोड़ूं?
वीडियो: 8.3 दस्तावेज़ टिप्पणियाँ - सी# सीखना 2024, अप्रैल
Anonim

कोड तत्व के लिए XML टिप्पणियाँ सम्मिलित करने के लिए

  1. टाइप करें /// C# में, या ''' in मूल दृश्य .
  2. संपादन मेनू से, IntelliSense >. चुनें टिप्पणी डालें .
  3. कोड तत्व पर या उसके ठीक ऊपर राइट-क्लिक या संदर्भ मेनू से, स्निपेट >. चुनें टिप्पणी डालें .

इसके अलावा, मैं XML में टिप्पणियाँ कैसे लिखूँ?

यदि आप चाहते हैं टिप्पणी में एक ही पंक्ति के बाहर एक्सएमएल कोड, अपना कर्सर उस पंक्ति की शुरुआत में डालें जिसे आप चाहते हैं टिप्पणी बाहर। एक विस्मयादिबोधक बिंदु और दो डैश के बाद प्रतीक से कम टाइप करें। अपने कर्सर को पंक्ति के अंत में ले जाएँ और फिर दो डैश टाइप करें जिसके बाद एक बड़ा-से-चिह्न हो।

कोई यह भी पूछ सकता है कि मैं C# में कोड कैसे लिखूं? प्रति कोड ए टिप्पणी , उसके बाद एक डबल फ़ॉरवर्ड स्लैश टाइप करें टिप्पणी . आप इस तकनीक का उपयोग a. जोड़ने के लिए कर सकते हैं टिप्पणी अपनी लाइन पर या जोड़ने के लिए a टिप्पणी के बाद कोड एक लाइन पर। अक्सर जब आप कोड , आप चाहे तो टिप्पणी के एक पूरे ब्लॉक के बाहर कोड बयान।

दूसरा, सी # में एक्सएमएल टिप्पणियां क्या हैं?

इनमें से एक है एक्सएमएल प्रलेखन टिप्पणियाँ , कई बार बुलाना एक्सएमएल टिप्पणियाँ , जो एक ट्रिपल स्लैश से शुरू होता है - /// । एक्सएमएल टिप्पणियाँ किसी प्रकार या सदस्य के बारे में जानकारी दिखाने के लिए Visual Studio और VS कोड की IntelliSense सुविधा द्वारा उपयोग किया जा सकता है; यह जानकारी आपके द्वारा अपने कोड दस्तावेज़ीकरण में डाली गई जानकारी से आती है।

आप कोड कैसे दस्तावेज करते हैं?

प्रलेखन लिखने के लिए सर्वोत्तम अभ्यास:

  1. एक README फ़ाइल शामिल करें जिसमें शामिल है।
  2. दूसरों के लिए इश्यू ट्रैकर की अनुमति दें।
  3. एक एपीआई दस्तावेज लिखें।
  4. अपने कोड का दस्तावेजीकरण करें।
  5. कोडिंग कन्वेंशन लागू करें, जैसे फ़ाइल संगठन, टिप्पणियाँ, नामकरण परंपराएँ, प्रोग्रामिंग प्रथाएँ, आदि।
  6. योगदानकर्ताओं के लिए जानकारी शामिल करें।

सिफारिश की: