स्व-दस्तावेजीकरण कोड (सेल्फ डॉक्यूमेंटिंग)
 | This article needs additional citations for verification. (March 2020) (Learn how and when to remove this template message) |
कंप्यूटर प्रोग्रामिंग में, स्व-दस्तावेजीकरण (या स्व-वर्णन) स्रोत कोड और उपयोगकर्ता इंटरफ़ेस नामकरण परंपराओं (प्रोग्रामिंग) और संरचित प्रोग्रामिंग परंपराओं का पालन करते हैं जो पूर्व विशिष्ट ज्ञान के बिना सिस्टम के उपयोग को सक्षम करते हैं।[1]वेब विकास में, स्व-दस्तावेजीकरण एक ऐसी वेबसाइट को संदर्भित करता है जो सार्वजनिक दस्तावेज़ीकरण के माध्यम से इसके निर्माण की पूरी प्रक्रिया को उजागर करती है, और जिसका सार्वजनिक दस्तावेज़ीकरण विकास प्रक्रिया का हिस्सा है।[citation needed]
उद्देश्य
स्व-दस्तावेजीकरण प्रणालियों के लिए सामान्यतः बताए गए उद्देश्यों में शामिल हैं:
- सोर्स कोड को पढ़ने और समझने में आसान बनाएं[2]* विरासत प्रणालियों को बनाए रखने या विस्तारित करने के लिए आवश्यक प्रयास को कम करें[2]* किसी सिस्टम के उपयोगकर्ताओं और डेवलपर्स के लिए टिप्पणी (कंप्यूटर प्रोग्रामिंग) या सॉफ्टवेयर मैनुअल जैसे द्वितीयक दस्तावेज़ स्रोतों से परामर्श लेने की आवश्यकता को कम करें[2]* स्व-निहित ज्ञान प्रतिनिधित्व के माध्यम से स्वचालन की सुविधा प्रदान करना
सम्मेलन
स्व-दस्तावेजीकरण कोड स्पष्ट रूप से मानव-पठनीय नामों का उपयोग करके लिखा जाता है, जिसमें आमतौर पर मानव भाषा में एक वाक्यांश शामिल होता है जो प्रतीक के अर्थ को दर्शाता है, जैसे कि आर्टिकल.नंबरऑफवर्ड्स या ट्राईओपन। कोड में एक स्पष्ट और स्वच्छ संरचना भी होनी चाहिए ताकि एक मानव पाठक उपयोग किए गए एल्गोरिदम को आसानी से समझ सके।
व्यावहारिक विचार
कुछ व्यावहारिक विचार हैं जो इस बात को प्रभावित करते हैं कि स्व-दस्तावेजीकरण प्रणाली के उद्देश्यों को कितनी अच्छी तरह साकार किया जा सकता है।
उदाहरण
नीचे स्व-दस्तावेजीकरण कोड का एक बहुत ही सरल उदाहरण दिया गया है, जिसमें मानव पाठकों के लिए कोड के तर्क को और अधिक स्पष्ट बनाने के लिए स्पष्ट टिप्पणियों के स्थान पर नामकरण परंपराओं का उपयोग किया गया है।
size_t count_alphabetic_chars(const char *text)
{
if (text == NULL)
return 0;
size_t count = 0;
while (*text != '\0')
{
if (is_alphabetic(*text))
count++;
text++;
}
return count;
}
आलोचना
जेफ रस्किन ने स्व-दस्तावेजीकरण कोड में विश्वास की आलोचना करते हुए कहा कि कोड इस तर्क को स्पष्ट नहीं कर सकता है कि कार्यक्रम क्यों लिखा जा रहा है या इसे इस तरह से क्यों लागू किया गया है।[3]
यह भी देखें
- ऑटोलॉजिकल शब्द
- कोड पठनीयता
- टिप्पणी (कंप्यूटर प्रोग्रामिंग)
- नियंत्रित प्राकृतिक भाषा
- साक्षर प्रोग्रामिंग
- प्राकृतिक भाषा प्रोग्रामिंग
संदर्भ
- ↑ Schach, Stephen R. (2011). Object-Oriented and Classical Software Engineering (8 ed.). McGraw-Hill Professional. pp. 505–507. ISBN 978-0-07337618-9. OCLC 477254661.
- ↑ 2.0 2.1 2.2 2.3 2.4 Paul, Matthias R. (2002-04-09). "Re: [fd-dev] ANNOUNCE: CuteMouse 2.0 alpha 1". freedos-dev. Archived from the original on 2020-03-24. Retrieved 2020-03-24.
[…] almost any numeric value in source code should be replaced by a corresponding symbol. This would greatly improve the self-explanatory aspect of source code and significantly ease maintenance of the code in the long run, as it would enable one to search for symbols to find relations between different excerpts of the code. […]
- ↑ Raskin, Jef (2005-03-18). "Comments Are More Important Than Code - The thorough use of internal documentation is one of the most-overlooked ways of improving software quality and speeding implementation". ACM Queue. Development. ACM, Inc. 3 (2). Archived from the original on 2020-03-24. Retrieved 2019-12-22. [1][2]
अग्रिम पठन
 | This programming-language-related article is a stub. You can help Wikipedia by expanding it. |
