MediaWiki Coding Conventions

मीडियाविकि कोडिंग कन्वेंशन

मीडियाविकि मीडियाविकि एक मुक्त और खुला स्रोत वेब एप्लिकेशन है, जिसका उपयोग विकी बनाने के लिए किया जाता है। यह विकिपीडिया, विकिबुक्स, और कई अन्य प्रमुख वेबसाइटों द्वारा संचालित है। मीडियाविकि में योगदान करने के लिए, या इसके आधार पर अपने स्वयं के एप्लिकेशन विकसित करने के लिए, कोडिंग कन्वेंशन का पालन करना महत्वपूर्ण है। ये कन्वेंशन कोड की पठनीयता, रखरखाव और स्थिरता सुनिश्चित करते हैं। यह लेख शुरुआती लोगों के लिए मीडियाविकि कोडिंग कन्वेंशन का विस्तृत अवलोकन प्रदान करता है।

सामान्य सिद्धांत

मीडियाविकि कोडिंग कन्वेंशन का मुख्य उद्देश्य कोड को पठनीय, सुसंगत और प्रबंधनीय बनाना है। निम्नलिखित सामान्य सिद्धांतों का पालन किया जाना चाहिए:

पठनीयता: कोड स्पष्ट और समझने में आसान होना चाहिए। सार्थक वेरिएबल और फ़ंक्शन नामों का उपयोग करें, और जटिल कोड को सरल भागों में विभाजित करें।
सुसंगतता: पूरे कोडबेस में एक समान शैली का उपयोग करें। इससे कोड को पढ़ना और समझना आसान हो जाता है।
रखरखाव: कोड को बनाए रखना आसान होना चाहिए। जटिल कोड से बचें, और अच्छी तरह से प्रलेखित कोड लिखें।
स्थिरता: कोड को स्थिर होना चाहिए और अप्रत्याशित व्यवहार नहीं करना चाहिए। सभी कोड को अच्छी तरह से परीक्षण किया जाना चाहिए।

PHP कोडिंग कन्वेंशन

मीडियाविकि मुख्य रूप से PHP में लिखा गया है। इसलिए, PHP कोडिंग कन्वेंशन का पालन करना विशेष रूप से महत्वपूर्ण है।

फ़ाइल एन्कोडिंग: सभी PHP फ़ाइलों को UTF-8 एन्कोडिंग में सहेजा जाना चाहिए।
इंडेंटेशन: कोड को इंडेंट करने के लिए चार स्पेस का उपयोग करें। टैब का उपयोग न करें।
लाइन लंबाई: प्रत्येक लाइन की लंबाई 80 वर्णों से अधिक नहीं होनी चाहिए।
नामकरण:

   *   वेरिएबल: वेरिएबल नामों को छोटे अक्षरों में लिखें, और शब्दों को अंडरस्कोर (_) से अलग करें। उदाहरण: `$user_name`, `$database_host`
   *   फ़ंक्शन: फ़ंक्शन नामों को छोटे अक्षरों में लिखें, और शब्दों को अंडरस्कोर (_) से अलग करें। उदाहरण: `get_user_name()`, `connect_to_database()`
   *   क्लास: क्लास नामों को अपरकेस पहले अक्षर के साथ लिखें, और शब्दों को अपरकेस पहले अक्षर के साथ अलग करें। उदाहरण: `UserName`, `DatabaseConnection`
   *   स्थिर: स्थिर (constant) नामों को सभी अपरकेस में लिखें, और शब्दों को अंडरस्कोर (_) से अलग करें। उदाहरण: `MAX_USERS`, `DATABASE_HOST`

टिप्पणियाँ: कोड को स्पष्ट रूप से प्रलेखित करें। प्रत्येक फ़ंक्शन और क्लास के लिए पीएचपीडॉक शैली में टिप्पणियाँ लिखें।
कोडिंग शैली: PSR-2 कोडिंग शैली मानक का पालन करें।

HTML कोडिंग कन्वेंशन

मीडियाविकि में HTML का उपयोग उपयोगकर्ता इंटरफ़ेस बनाने के लिए किया जाता है। HTML कोडिंग कन्वेंशन का पालन करना महत्वपूर्ण है ताकि यह सुनिश्चित हो सके कि इंटरफ़ेस सुसंगत और सुलभ है।

डॉकटाइप: हमेशा HTML5 डॉकटाइप का उपयोग करें: `<!DOCTYPE html>`
एन्कोडिंग: हमेशा `UTF-8` एन्कोडिंग का उपयोग करें।
इंडेंटेशन: HTML टैग को इंडेंट करने के लिए दो स्पेस का उपयोग करें।
टैग: सभी टैग को बंद करें।
एट्रीब्यूट: एट्रीब्यूट को डबल कोट्स में संलग्न करें।
CSS: CSS का उपयोग स्टाइलिंग के लिए करें। इनलाइन स्टाइलिंग से बचें।
सुलभता: सुनिश्चित करें कि HTML सुलभ है। `alt` एट्रीब्यूट का उपयोग छवियों के लिए करें, और स्क्रीन रीडर के लिए उपयुक्त टैग का उपयोग करें।

JavaScript कोडिंग कन्वेंशन

मीडियाविकि में JavaScript का उपयोग इंटरैक्टिव सुविधाओं को जोड़ने के लिए किया जाता है। JavaScript कोडिंग कन्वेंशन का पालन करना महत्वपूर्ण है ताकि यह सुनिश्चित हो सके कि कोड विश्वसनीय और सुरक्षित है।

फ़ाइल एन्कोडिंग: सभी JavaScript फ़ाइलों को `UTF-8` एन्कोडिंग में सहेजा जाना चाहिए।
इंडेंटेशन: कोड को इंडेंट करने के लिए दो स्पेस का उपयोग करें।
लाइन लंबाई: प्रत्येक लाइन की लंबाई 80 वर्णों से अधिक नहीं होनी चाहिए।
नामकरण:

   *   वेरिएबल: वेरिएबल नामों को छोटे अक्षरों में लिखें, और शब्दों को अंडरस्कोर (_) से अलग करें। उदाहरण: `userName`, `databaseHost`
   *   फ़ंक्शन: फ़ंक्शन नामों को छोटे अक्षरों में लिखें, और शब्दों को अंडरस्कोर (_) से अलग करें। उदाहरण: `getUserName()`, `connectToDatabase()`

टिप्पणियाँ: कोड को स्पष्ट रूप से प्रलेखित करें।
सुलभता: सुनिश्चित करें कि JavaScript सुलभ है।

CSS कोडिंग कन्वेंशन

मीडियाविकि में CSS का उपयोग स्टाइलिंग के लिए किया जाता है। CSS कोडिंग कन्वेंशन का पालन करना महत्वपूर्ण है ताकि यह सुनिश्चित हो सके कि इंटरफ़ेस सुसंगत और रखरखाव योग्य है।

फ़ाइल एन्कोडिंग: सभी CSS फ़ाइलों को `UTF-8` एन्कोडिंग में सहेजा जाना चाहिए।
इंडेंटेशन: CSS नियमों को इंडेंट करने के लिए दो स्पेस का उपयोग करें।
सिलेक्टर: सिलेक्टर को स्पष्ट और विशिष्ट बनाएं।
प्रॉपर्टी: प्रॉपर्टी को वर्णानुक्रम में लिखें।
रंग: रंगों को हेक्साडेसिमल कोड में लिखें।
टिप्पणियाँ: CSS को स्पष्ट रूप से प्रलेखित करें।

डेटाबेस इंटरैक्शन

मीडियाविकि MySQL डेटाबेस का उपयोग करता है। डेटाबेस इंटरैक्शन के लिए निम्नलिखित कन्वेंशन का पालन किया जाना चाहिए:

SQL इंजेक्शन: SQL इंजेक्शन हमलों से बचने के लिए हमेशा तैयार किए गए स्टेटमेंट का उपयोग करें।
डेटा प्रकार: डेटा प्रकारों का सही उपयोग करें।
इंडेक्सिंग: डेटाबेस प्रदर्शन को बेहतर बनाने के लिए इंडेक्स का उपयोग करें।
लेनदेन: डेटा अखंडता सुनिश्चित करने के लिए लेनदेन का उपयोग करें।

सुरक्षा संबंधी विचार

मीडियाविकि कोडिंग करते समय सुरक्षा को हमेशा ध्यान में रखना चाहिए। निम्नलिखित सुरक्षा संबंधी विचारों का पालन किया जाना चाहिए:

इनपुट सत्यापन: सभी उपयोगकर्ता इनपुट को सत्यापित करें।
आउटपुट एस्केपिंग: आउटपुट को प्रदर्शित करने से पहले एस्केप करें।
क्रॉस-साइट स्क्रिप्टिंग (XSS): XSS हमलों से बचने के लिए उचित सुरक्षा उपाय करें।
क्रॉस-साइट रिक्वेस्ट फोर्जरी (CSRF): CSRF हमलों से बचने के लिए उचित सुरक्षा उपाय करें।
सत्र प्रबंधन: सत्रों को सुरक्षित रूप से प्रबंधित करें।

अन्य महत्वपूर्ण पहलू

अंतर्राष्ट्रीयकरण (I18n): मीडियाविकि बहुभाषी है। सभी स्ट्रिंग्स को अंतर्राष्ट्रीयकरण के लिए तैयार किया जाना चाहिए। gettext का उपयोग अनुवाद के लिए करें।
यूनिट परीक्षण: यूनिट परीक्षण लिखकर कोड की गुणवत्ता सुनिश्चित करें।
कोड समीक्षा: कोड को कमिट करने से पहले कोड समीक्षा करवाएं।
संस्करण नियंत्रण: Git जैसे संस्करण नियंत्रण प्रणाली का उपयोग करें।
मीडियाविकि एक्सटेंशन: यदि आप कोई एक्सटेंशन बना रहे हैं, तो मीडियाविकि एक्सटेंशन डेवलपमेंट दिशानिर्देशों का पालन करें।

उदाहरण तालिका: PHP कोड में इंडेंटेशन

PHP कोड में इंडेंटेशन का उदाहरण
! कोड	! विवरण
function my_function($param1, $param2) { if ($param1 > $param2) { echo "Param1 is greater than Param2"; } else { echo "Param2 is greater than or equal to Param1"; } }	चार स्पेस का इंडेंटेशन उपयोग किया गया है।
$my_variable = array( 'key1' => 'value1', 'key2' => 'value2' );	एरे के तत्वों को इंडेंट किया गया है।

आगे के संसाधन

यह लेख मीडियाविकि कोडिंग कन्वेंशन का एक व्यापक अवलोकन प्रदान करता है। इन कन्वेंशन का पालन करके, आप उच्च गुणवत्ता वाला, पठनीय और रखरखाव योग्य कोड लिख सकते हैं। जो मीडियाविकि समुदाय में योगदान देना चाहते हैं और इस शक्तिशाली प्लेटफ़ॉर्म की क्षमताओं को बढ़ाना चाहते हैं, उनके लिए यह आवश्यक है। यह सुनिश्चित करने के लिए कि आपका काम स्वीकार किया जाए और समुदाय के मानकों को पूरा करे, इन दिशानिर्देशों का पालन करना महत्वपूर्ण है।

तकनीकी विश्लेषण वॉल्यूम विश्लेषण बाइनरी ऑप्शन रणनीतियां जोखिम प्रबंधन ट्रेडिंग मनोविज्ञान वित्तीय बाजार इकोनॉमिक इंडिकेटर्स ऑप्शन ट्रेडिंग डेरिवेटिव्स पोर्टफोलियो प्रबंधन निवेश रणनीति वित्तीय योजना पूंजी बाजार शेयर बाजार मुद्रा बाजार कमोडिटी बाजार बांड बाजार रियल एस्टेट निवेश क्रिप्टोकरेंसी ब्लॉकचेन तकनीक आर्टिफिशियल इंटेलिजेंस और ट्रेडिंग

अभी ट्रेडिंग शुरू करें

IQ Option पर रजिस्टर करें (न्यूनतम जमा $10) Pocket Option में खाता खोलें (न्यूनतम जमा $5)

हमारे समुदाय में शामिल हों

हमारे Telegram चैनल @strategybin से जुड़ें और प्राप्त करें: ✓ दैनिक ट्रेडिंग सिग्नल ✓ विशेष रणनीति विश्लेषण ✓ बाजार की प्रवृत्ति पर अलर्ट ✓ शुरुआती के लिए शिक्षण सामग्री