वेबएपी सहायता पृष्ठ विवरण

Question

सहायक पृष्ठ और परिचय पैराग्राफ पर Webapi विधि का वर्णन क्या करता है?

Answer 1

इस article के अनुसार आप दस्तावेज़ दस्तावेज़ बनाने के लिए XML दस्तावेज़ टिप्पणियों का उपयोग कर सकते हैं। , इस सुविधा को सक्षम फ़ाइल क्षेत्रों को खोलने/HelpPage/App_Start/HelpPageConfig.cs और निम्न पंक्ति uncomment करने के लिए:

config.SetDocumentationProvider(new XmlDocumentationProvider(
    HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml"))); 

अब एक्सएमएल प्रलेखन सक्षम करें। समाधान एक्सप्लोरर में, प्रोजेक्ट पर राइट-क्लिक करें और गुण चुनें। बिल्ड पेज का चयन करें।

आउटपुट के तहत, XML दस्तावेज़ फ़ाइल की जांच करें। संपादन बॉक्स में, "App_Data/XmlDocument.xml" टाइप करें।

नियंत्रक विधियों में कुछ दस्तावेज़ टिप्पणियां जोड़ें। उदाहरण के लिए:

/// <summary> 
/// Gets some very important data from the server. 
/// </summary> 
public IEnumerable<string> Get() 
{ 
    return new string[] { "value1", "value2" }; 
} 

/// <summary> 
/// Looks up some data by ID. 
/// </summary> 
/// <param name="id">The ID of the data.</param> 
public string Get(int id) 
{ 
    return "value"; 
} 

Answer 2

विवरण आप इस का पालन करने की जरूरत है देखने के लिए:

1. अपने ग्राहक नियंत्रक में हर कार्रवाई एक एक्सएमएल प्रलेखन
2. ओपन परियोजना के गुणों होना आवश्यक है कि इसमें आपके नियंत्रक शामिल हैं और इस तरह एक्सएमएल डॉक्यूमेनेशन सक्षम करते हैं:
3. HelpPageConfig वर्ग (क्षेत्रों/HelpPage/App_Start/HelpPageConfig.cs) uncomment लाइन 19 के लिए रजिस्टर विधि में और भूल नहीं है इस तरह फ़ाइल पथ को बदलने के लिए:

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/MvcApplication4.XML")));

यह सब आपको करना होगा। अंतिम बात यह है कि अपनी परियोजना में App_Data में बनाई गई फ़ाइल को शामिल करना है ताकि फाइल उत्पादन में तैनात की जा सके।