मैं अपने डेवलपर्स से पूछता हूं जो स्टाइलकॉप के दिशानिर्देशों का पालन करने के लिए सी # कोड लिखते हैं। यह कोड के लिए बहुत अच्छा है, लेकिन मेरे पास हमेशा दस्तावेज के बारे में प्रश्न हैं (ठीक है ... ठीक है ... इसलिए कोई भी नहीं पूछता है, क्योंकि प्रोग्रामर दस्तावेज़ीकरण से नफरत करते हैं) शैली। मैं एमएसडीएन की शैली की प्रतिलिपि बनाने का सुझाव दे सकता हूं, लेकिन मुझे उत्सुकता है कि माइक्रोसॉफ्ट या किसी और ने इसके बारे में कुछ प्रकाशित किया है या नहीं।क्या सी # एक्सएमएल दस्तावेज के लिए स्टाइल दिशानिर्देश प्रकाशित हैं?
उदाहरण के लिए, रचनाकारों को निम्नानुसार दस्तावेज किया गया है।
/// <summary>
/// Initializes a new instance of <c>MyClass</c> using the specified <c>BaseMyClass</c>.
/// </summary>
/// <param name="myParam">The <c>MyParam</c> of the current session.</param>
मैं यहां पर बहस कैसे लिखी जानी चाहिए इस पर बहस करने की कोशिश नहीं कर रहा हूं। मैं प्रलेखन के लिए सुझाए गए वाक्यविन्यास के बारे में कुछ प्रकार के प्रकाशित दिशानिर्देशों की तलाश में हूं।
अग्रिम धन्यवाद!
आप GhostDoc भी प्रयास करने के लिए, यदि आप इसे इस्तेमाल नहीं किया है चाहते हो सकता है: http://submain.com/products/ghostdoc.aspx यह काफी बारीकी से StyleCop दिशा निर्देशों ... –
StyleCop दिशा निर्देशों के लिए पर्याप्त हैं इस प्रकार है। मैं बस कुछ ऐसे चीजों की तलाश में हूं जो मैं अपने डेवलपर्स को प्रकाशित कर सकता हूं। हालांकि धन्यवाद! –