मैं अपने एंटिटी, बिजनेस लॉजिक और डेटा एक्सेस क्लासेस के लिए सूचनात्मक वर्ग प्रलेखन प्रारूप की तलाश कर रहा हूं।
मुझे यहाँ से दो प्रारूप मिले
प्रारूप 1
///-----------------------------------------------------------------
/// Namespace: <Class Namespace>
/// Class: <Class Name>
/// Description: <Description>
/// Author: <Author> Date: <DateTime>
/// Notes: <Notes>
/// Revision History:
/// Name: Date: Description:
///-----------------------------------------------------------------प्रारूप 2
// ===============================
// AUTHOR :
// CREATE DATE :
// PURPOSE :
// SPECIAL NOTES:
// ===============================
// Change History:
//
//==================================मुझे लगता है कि निम्नलिखित मूल तत्व हैं
- लेखक
- रचना तिथि
- विवरण
- संशोधन इतिहास
वैसे भी नाम और वर्ग का नाम वहाँ होगा।
कृपया मुझे अपने विचारों से अवगत कराएं, कौन सा प्रारूप अनुशंसित है और क्या संशोधन इतिहास लिखने का कोई मानक तरीका है?
8
संशोधन इतिहास यदि आप वीसीएस के कुछ रूप का उपयोग कर रहे हैं, तो मेरी राय में ध्यान रखा जाता है। इसे यहां रखकर यह एक और स्थान जोड़ता है जिसे आपको दस्तावेज़ को याद रखने की आवश्यकता होती है, तो वीसीएस को आपके लिए क्यों नहीं करना चाहिए और अपने कोड दस्तावेज़ को यथासंभव संक्षिप्त रखें।
—
क्रिस
लेखक और निर्माण की तिथि भी स्रोत नियंत्रण द्वारा नियंत्रित की जाती है। आपको केवल एक विवरण की आवश्यकता है।
—
माइक सेमोर