कोडिंग स्टाइल गाइड

From binaryoption
Jump to navigation Jump to search
Баннер1

कोडिंग स्टाइल गाइड

यह पृष्ठ MediaWiki 1.40 के लिए कोडिंग स्टाइल गाइड प्रदान करता है। यह सुनिश्चित करना महत्वपूर्ण है कि MediaWiki इंस्टॉलेशन में सभी कोड एक सुसंगत शैली का पालन करें, जिससे पठनीयता, रखरखाव और सहयोग में सुधार हो सके। यह गाइड PHP, JavaScript, CSS और SQL सहित विभिन्न भाषाओं के लिए दिशानिर्देशों को शामिल करता है। यह गाइड मीडियाविकि विकास प्रक्रिया का एक अभिन्न अंग है।

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

  • **पठनीयता:** कोड स्पष्ट और समझने में आसान होना चाहिए। जटिल अभिव्यक्तियों से बचें और सार्थक चर नामों का उपयोग करें।
  • **सुसंगतता:** पूरे कोडबेस में एक समान शैली का पालन करें।
  • **मानकीकरण:** स्थापित कोडिंग मानकों का पालन करें, जैसे PSR (PHP Standards Recommendations)।
  • **टिप्पणी:** कोड को अच्छी तरह से टिप्पणी करें, यह समझाते हुए कि यह क्या करता है और क्यों।
  • **मॉड्यूलरिटी:** कोड को छोटे, प्रबंधनीय मॉड्यूल में विभाजित करें।
  • **दस्तावेज़ीकरण:** सभी सार्वजनिक फ़ंक्शन, क्लास और विधियों को दस्तावेज़ित करें। मीडियाविकि एपीआई दस्तावेज़ीकरण के लिए एक उदाहरण है।

PHP कोडिंग स्टाइल

PHP MediaWiki के मुख्य कोडबेस की भाषा है। PHP के लिए निम्नलिखित दिशानिर्देशों का पालन करें:

  • **फ़ाइल एन्कोडिंग:** सभी PHP फ़ाइलों को UTF-8 एन्कोडिंग में सहेजा जाना चाहिए।
  • **शॉर्ट टैग:** शॉर्ट टैग (`<?`) के उपयोग से बचें। हमेशा पूर्ण टैग (`<?php`) का उपयोग करें।
  • **इंडेंटेशन:** इंडेंटेशन के लिए 4 स्पेस का उपयोग करें। टैब का उपयोग न करें।
  • **लाइन की लंबाई:** प्रत्येक लाइन को 80 वर्णों से कम रखें।
  • **नामकरण कन्वेंशन:**
   *   क्लास नाम: अपर कैमल केस (उदाहरण: `MyClass`)
   *   फ़ंक्शन और विधि नाम: लोअर कैमल केस (उदाहरण: `myFunction`)
   *   चर नाम: लोअर केस (उदाहरण: `myVariable`)
   *   स्थिरांक: अपर केस (उदाहरण: `MY_CONSTANT`)
  • **स्पेसिंग:** ऑपरेटरों के आसपास स्पेस का उपयोग करें (उदाहरण: `$a = $b + $c;`)।
  • **टिप्पणी:**
   *   सिंगल-लाइन टिप्पणियों के लिए `//` का उपयोग करें।
   *   मल्टी-लाइन टिप्पणियों के लिए `/* ... */` का उपयोग करें।
   *   PHPdoc शैली में फ़ंक्शन और क्लास को दस्तावेज़ित करें।
  • **त्रुटि हैंडलिंग:** अपवादों का उपयोग त्रुटियों को संभालने के लिए करें।
  • **सुरक्षा:** SQL इंजेक्शन और क्रॉस-साइट स्क्रिप्टिंग (XSS) जैसी सुरक्षा कमजोरियों से बचें। मीडियाविकि सुरक्षा के बारे में अधिक जानकारी के लिए।
  • **PSR अनुपालन:** PSR-1, PSR-2 और PSR-12 जैसे PHP मानकों का पालन करें।

JavaScript कोडिंग स्टाइल

JavaScript का उपयोग MediaWiki में इंटरैक्टिव सुविधाओं के लिए किया जाता है। JavaScript के लिए निम्नलिखित दिशानिर्देशों का पालन करें:

  • **फ़ाइल एन्कोडिंग:** सभी JavaScript फ़ाइलों को UTF-8 एन्कोडिंग में सहेजा जाना चाहिए।
  • **इंडेंटेशन:** इंडेंटेशन के लिए 4 स्पेस का उपयोग करें। टैब का उपयोग न करें।
  • **लाइन की लंबाई:** प्रत्येक लाइन को 80 वर्णों से कम रखें।
  • **नामकरण कन्वेंशन:**
   *   क्लास नाम: अपर कैमल केस (उदाहरण: `MyClass`)
   *   फ़ंक्शन और विधि नाम: लोअर कैमल केस (उदाहरण: `myFunction`)
   *   चर नाम: लोअर कैमल केस (उदाहरण: `myVariable`)
   *   स्थिरांक: अपर केस (उदाहरण: `MY_CONSTANT`)
  • **स्पेसिंग:** ऑपरेटरों के आसपास स्पेस का उपयोग करें (उदाहरण: `var a = b + c;`)।
  • **टिप्पणी:**
   *   सिंगल-लाइन टिप्पणियों के लिए `//` का उपयोग करें।
   *   मल्टी-लाइन टिप्पणियों के लिए `/* ... */` का उपयोग करें।
   *   JSDoc शैली में फ़ंक्शन और क्लास को दस्तावेज़ित करें।
  • **सेमीकोलन:** सभी कथनों के अंत में सेमीकोलन का उपयोग करें।
  • **स्ट्रिक्ट मोड:** हमेशा स्ट्रिक्ट मोड (`'use strict';`) का उपयोग करें।
  • **वेरिएबल घोषणा:** हमेशा `var`, `let` या `const` का उपयोग करके चर घोषित करें।
  • **इक्वॅलिटी ऑपरेटर:** `===` और `!==` का उपयोग करें, `==` और `!=` का नहीं।

CSS कोडिंग स्टाइल

CSS का उपयोग MediaWiki के दृश्य स्वरूप को स्टाइल करने के लिए किया जाता है। CSS के लिए निम्नलिखित दिशानिर्देशों का पालन करें:

  • **फ़ाइल एन्कोडिंग:** सभी CSS फ़ाइलों को UTF-8 एन्कोडिंग में सहेजा जाना चाहिए।
  • **इंडेंटेशन:** इंडेंटेशन के लिए 4 स्पेस का उपयोग करें। टैब का उपयोग न करें।
  • **लाइन की लंबाई:** प्रत्येक लाइन को 80 वर्णों से कम रखें।
  • **सेलेक्टर:** विशिष्ट सेलेक्टर का उपयोग करें।
  • **गुण:** गुणों को वर्णानुक्रम में व्यवस्थित करें।
  • **मान:** मानों को उद्धरण चिह्नों में संलग्न करें।
  • **टिप्पणी:**
   *   टिप्पणियों के लिए `/* ... */` का उपयोग करें।
  • **शॉर्टहैंड गुण:** जहां संभव हो, शॉर्टहैंड गुणों का उपयोग करें (उदाहरण: `margin: 10px 20px;`)।
  • **रंग:** हेक्स कोड या आरजीबीए मानों का उपयोग करके रंग निर्दिष्ट करें।

SQL कोडिंग स्टाइल

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

  • **कीवर्ड:** SQL कीवर्ड को अपर केस में लिखें (उदाहरण: `SELECT`, `FROM`, `WHERE`)।
  • **टेबल और कॉलम नाम:** टेबल और कॉलम नामों को लोअर केस में लिखें।
  • **इंडेंटेशन:** SQL कथनों को इंडेंट करें ताकि पठनीयता बढ़ सके।
  • **टिप्पणी:**
   *   टिप्पणियों के लिए `--` का उपयोग करें।
  • **सुरक्षा:** SQL इंजेक्शन से बचने के लिए पैरामीटराइज़्ड प्रश्नों का उपयोग करें।
  • **इंडेक्सिंग:** क्वेरी प्रदर्शन को अनुकूलित करने के लिए उचित इंडेक्स का उपयोग करें।

अन्य दिशानिर्देश

  • **संस्करण नियंत्रण:** Git जैसे संस्करण नियंत्रण प्रणाली का उपयोग करें।
  • **कोड समीक्षा:** सभी कोड को मर्ज करने से पहले समीक्षा करें।
  • **स्वचालित परीक्षण:** स्वचालित परीक्षण लिखें ताकि यह सुनिश्चित हो सके कि कोड सही ढंग से काम करता है।
  • **निरंतर एकीकरण:** निरंतर एकीकरण प्रणाली का उपयोग करें ताकि कोड को स्वचालित रूप से बनाया और परीक्षण किया जा सके।
  • **मीडियाविकि कॉन्फ़िगरेशन** फ़ाइलों को सावधानी से संपादित करें।

बाइनरी ऑप्शन से संबंधित अवधारणाओं का एकीकरण

हालांकि यह कोडिंग स्टाइल गाइड है, बाइनरी ऑप्शन के क्षेत्र में विशेषज्ञता के कारण, कुछ संबंधित अवधारणाओं को उदाहरण के रूप में शामिल किया जा सकता है। ध्यान दें कि ये उदाहरण केवल प्रदर्शन के लिए हैं और MediaWiki के मूल कोडिंग स्टाइल से विचलित नहीं होने चाहिए।

  • **बाइनरी ऑप्शन रणनीति**: एक रणनीति के लिए डेटा संरचना को परिभाषित करते समय स्पष्ट नामकरण कन्वेंशन का उपयोग करें, जैसे `BollingerBandsStrategy`।
  • **तकनीकी विश्लेषण**: तकनीकी संकेतकों की गणना करने वाले फ़ंक्शन को दस्तावेज़ित करें, जिसमें इनपुट पैरामीटर और आउटपुट मान शामिल हैं। उदाहरण के लिए, `calculateMovingAverage($data, $period)`।
  • **ट्रेडिंग वॉल्यूम विश्लेषण**: वॉल्यूम डेटा को संसाधित करने वाले कोड में त्रुटि हैंडलिंग को शामिल करें, ताकि डेटा त्रुटियों को ठीक से संभाला जा सके।
  • **संकेतक**: RSI (Relative Strength Index) जैसे संकेतकों की गणना करने वाले फ़ंक्शन को मॉड्यूलराइज़ करें ताकि पुन: प्रयोज्यता बढ़ सके।
  • **ट्रेंड्स**: विभिन्न प्रकार के ट्रेंड्स (अपट्रेंड, डाउनट्रेंड, साइडवेज़ ट्रेंड) का पता लगाने वाले एल्गोरिदम को स्पष्ट रूप से टिप्पणी करें।
  • **रिस्क मैनेजमेंट**: रिस्क मैनेजमेंट एल्गोरिदम (जैसे, मार्टिंगेल रणनीति) को लागू करते समय सुरक्षा और सटीकता सुनिश्चित करें।
  • **पैसे का प्रबंधन**: पैसे के प्रबंधन से संबंधित गणनाओं के लिए स्पष्ट और सटीक कोड लिखें।
  • **बाइनरी ऑप्शन ब्रोकर**: ब्रोकर एपीआई के साथ इंटरैक्ट करने वाले कोड को सुरक्षित और विश्वसनीय बनाएं।
  • **उच्च/निम्न बाइनरी ऑप्शन**: उच्च/निम्न बाइनरी ऑप्शन के लिए डेटा प्रोसेसिंग लॉजिक को स्पष्ट रूप से परिभाषित करें।
  • **टच/नो-टच बाइनरी ऑप्शन**: टच/नो-टच बाइनरी ऑप्शन के लिए एल्गोरिदम को मॉड्यूलराइज़ करें।
  • **बाइनरी ऑप्शन सिग्नल**: सिग्नल उत्पन्न करने वाले कोड को दस्तावेज़ित करें, जिसमें सिग्नल की सटीकता और विश्वसनीयता शामिल है।
  • **बाइनरी ऑप्शन ट्रेडिंग प्लेटफॉर्म**: ट्रेडिंग प्लेटफॉर्म के साथ इंटरैक्ट करने वाले कोड को सुरक्षित और कुशल बनाएं।
  • **बाइनरी ऑप्शन चार्ट**: चार्टिंग डेटा को संसाधित करने वाले कोड को अनुकूलित करें ताकि प्रदर्शन में सुधार हो सके।
  • **बाइनरी ऑप्शन डेमो अकाउंट**: डेमो अकाउंट के साथ इंटरैक्ट करने वाले कोड को अलग रखें ताकि वास्तविक ट्रेडिंग डेटा से कोई हस्तक्षेप न हो।
  • **बाइनरी ऑप्शन टिप्स**: ट्रेडिंग टिप्स को प्रदर्शित करने वाले कोड को सुरक्षित और विश्वसनीय बनाएं।
  • **बाइनरी ऑप्शन जोखिम**: जोखिम प्रबंधन से संबंधित कोड को स्पष्ट रूप से दस्तावेज़ित करें।
  • **बाइनरी ऑप्शन लाभ**: लाभ की गणना करने वाले कोड को सटीक और विश्वसनीय बनाएं।
  • **बाइनरी ऑप्शन रणनीति उदाहरण**: विभिन्न रणनीतियों के उदाहरणों को प्रदर्शित करने वाले कोड को स्पष्ट और समझने में आसान बनाएं।
  • **बाइनरी ऑप्शन विश्लेषण**: डेटा विश्लेषण से संबंधित कोड को अनुकूलित करें ताकि प्रदर्शन में सुधार हो सके।
  • **बाइनरी ऑप्शन पूर्वानुमान**: पूर्वानुमान एल्गोरिदम को स्पष्ट रूप से दस्तावेज़ित करें।
  • **बाइनरी ऑप्शन ऑटोमेटेड ट्रेडिंग**: ऑटोमेटेड ट्रेडिंग सिस्टम के लिए कोड को सुरक्षित और विश्वसनीय बनाएं।
  • **बाइनरी ऑप्शन संकेत सेवा**: संकेत सेवा के साथ इंटरैक्ट करने वाले कोड को सुरक्षित और कुशल बनाएं।
  • **बाइनरी ऑप्शन शिक्षा**: शैक्षिक सामग्री प्रदर्शित करने वाले कोड को स्पष्ट और समझने में आसान बनाएं।
  • **बाइनरी ऑप्शन विनियमन**: विनियमन से संबंधित कोड को अपडेट रखें।
  • **बाइनरी ऑप्शन धोखाधड़ी**: धोखाधड़ी का पता लगाने वाले कोड को सुरक्षित और विश्वसनीय बनाएं।

यह कोडिंग स्टाइल गाइड MediaWiki 1.40 के लिए एक प्रारंभिक बिंदु है। यह समय के साथ विकसित हो सकता है क्योंकि नए मानक और सर्वोत्तम प्रथाएं उभरती हैं।

मीडियाविकि मैनुअल मीडियाविकि एक्सटेंशन मीडियाविकि सर्वर मीडियाविकि डेटाबेस मीडियाविकि इंटरफेस मीडियाविकि सुरक्षा मीडियाविकि एपीआई मीडियाविकि विकास मीडियाविकि कॉन्फ़िगरेशन मीडियाविकि रखरखाव

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

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

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

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

Баннер