क्या सी # कोड पर टिप्पणी करने के लिए एक मानक सम्मेलन (जैसे phpdoc या पायथन की डॉकस्ट्रिंग) है ताकि वर्ग दस्तावेज़ स्वचालित रूप से स्रोत कोड से उत्पन्न हो सके?क्या सी # कोड पर टिप्पणी करने के लिए कोई मानक (जैसे phpdoc या पायथन की डॉकस्ट्रिंग) है?
आप XML शैली टिप्पणियों का उपयोग कर सकते हैं और उन टिप्पणियों को API दस्तावेज़ों में खींचने के लिए टूल का उपयोग कर सकते हैं।
/// <summary>
/// Authenticates a user based on a username and password.
/// </summary>
/// <param name="username">The username.</param>
/// <param name="password">The password.</param>
/// <returns>
/// True, if authentication is successful, otherwise False.
/// </returns>
/// <remarks>
/// For use with local systems
/// </remarks>
public override bool Authenticate(string username, string password)
कुछ आइटम की सुविधा के लिए इस प्रकार हैं::
GhostDoc है, जो एक भी शॉर्टकट कुंजी दे स्वचालित रूप से एक वर्ग या विधि के लिए टिप्पणियों उत्पन्न करने के लिए
यहाँ टिप्पणी शैली का एक उदाहरण है। Sandcastle, जो एक्सएमएल टिप्पणियों से एमएसडीएन शैली दस्तावेज उत्पन्न करता है।
/// <summary>
///
/// </summary>
/// <param name="strFilePath"></param>
सी # documentation commands मज़ा में बनाया गया है!
माइक्रोसॉफ्ट का उपयोग करता है "XML Documentation Comments" जो आईडीई IntelliSense विवरण दे देंगे और यह भी करने के लिए आप की अनुमति देने के लिए यदि आप एक्सएमएल फ़ाइल उत्पादन की पीढ़ी पर बारी एक उपकरण का उपयोग कर स्वत: जनरेट MSDN शैली प्रलेखन ऐसे सैंडकैसल के रूप में।
प्रलेखन के लिए XML फ़ाइल की पीढ़ी को चालू करने के लिए, दृश्य स्टूडियो में किसी प्रोजेक्ट पर राइट क्लिक करें, "गुण" पर क्लिक करें और "बिल्ड" टैब पर जाएं। नीचे की ओर आप अपनी एक्सएमएल टिप्पणियां आउटपुट फ़ाइल के लिए एक स्थान निर्दिष्ट कर सकते हैं।
पिछले उत्तर एक्सएमएल वाक्यविन्यास को पूरी तरह से इंगित करते हैं। मैं बस free (and open-source) nDoc help library generator के लिए मेरी सिफारिश में फेंकना चाहता था जो एक परियोजना में सभी टिप्पणियों को पार करता है।
मुझे हमेशा 2 या अधिक तारों के साथ खोले गए ब्लॉक टिप्पणियों का उपयोग करने के लिए कहा गया था जो दस्तावेज़ीकरण टिप्पणियों को सीमित करते हैं।
/**
Documentation goes here.
(flowerboxes optional)
*/
यह जावा में है, मुझे ऐसा लगता है –
देखें http://stackoverflow.com/questions/319632/docproject-vs-sandcastle-help-file-builder नवीनीकृत किया है Sandcastle के बारे में अधिक जानकारी के लिए -गुई। –