SQL में टिप्पणियाँ कैसे बनाएँ

SQL, जिसका अर्थ Structured Query Language है, रिलेशनल डेटाबेस को प्रबंधित और संचालित करने के लिए एक शक्तिशाली भाषा है। यद्यपि पहली नज़र में SQL क्वेरी आत्म-व्याख्यात्मक लग सकती हैं, SQL स्टेटमेंट्स में टिप्पणियाँ जोड़ने से आपके कोड की पठनीयता और अनुरक्षण क्षमता बेहतर होती है।

इस ट्यूटोरियल में, हम देखेंगे कि SQL में टिप्पणियाँ कैसे जोड़ें ताकि आपका कोड सरल और पढ़ने में आसान हो।

त्वरित उत्तर: SQL में टिप्पणियाँ कैसे बनाएँ

अपनी SQL क्वेरी में टिप्पणियाँ जोड़ने के तीन तरीके हैं:

1. सिंगल-लाइन टिप्पणियाँ: सिंगल-लाइन टिप्पणियाँ -- डबल हाइफ़न से शुरू होती हैं।

2. इनलाइन टिप्पणियाँ: इनलाइन टिप्पणियाँ उसी पंक्ति में SQL स्टेटमेंट के बाद -- से शुरू होती हैं।

3. मल्टीलाइन टिप्पणियाँ या ब्लॉक टिप्पणियाँ: मल्टीलाइन टिप्पणियाँ /* से शुरू होती हैं और */ पर समाप्त होती हैं।

 -- Single line comment
SELECT * 
FROM TABLE

SELECT * 
FROM TABLE -- Inline comment

/* Multiline
comment */ 
SELECT * 
FROM TABLE  संचालित द्वारा

SQL टिप्पणियाँ महत्वपूर्ण क्यों हैं?

यहाँ तीन प्रमुख कारण हैं कि SQL टिप्पणियाँ क्यों महत्वपूर्ण हैं:

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

SQL टिप्पणियों के प्रकार

आपकी आवश्यकताओं और प्राथमिकताओं के आधार पर, SQL स्क्रिप्ट्स में टिप्पणियाँ जोड़ने के तीन तरीके हैं।

सिंगल-लाइन टिप्पणियाँ

यदि आपकी टिप्पणी एक ही पंक्ति में समा जाती है, तो डबल हाइफ़न का उपयोग करें। आम तौर पर, आप संदर्भ देने के लिए ऐसी टिप्पणियाँ संबंधित कोड ब्लॉक के ऊपर रखते हैं।

--select the department name from the department table
SELECT dept_name
FROM employees.departments;संचालित द्वारा

इनलाइन टिप्पणियाँ

जैसा कि हम निम्न उदाहरण में देख सकते हैं, SQL में सिंगल-लाइन और इनलाइन टिप्पणियाँ एक ही सिंटैक्स उपयोग करती हैं और मूलतः समान हैं; अंतर केवल उनके स्थान और उपयोग में है। इनलाइन टिप्पणियाँ प्रायः क्वेरी के किसी विशेष हिस्से को समझाने के लिए उपयोग होती हैं।

SELECT DISTINCT title -- It excludes duplicate titles using the DISTINCT keyword.
FROM employees.titles
ORDER BY title ASC -- The results are sorted alphabetically by the 'title' column.
LIMIT 10;
संचालित द्वारा

मल्टीलाइन टिप्पणियाँ या ब्लॉक टिप्पणियाँ

आप SQL में कई पंक्तियों में फैली लंबी टिप्पणियाँ जोड़ने के लिए मल्टीलाइन टिप्पणियों का उपयोग कर सकते हैं। मल्टीलाइन टिप्पणियाँ जोड़ने के लिए, अपने पाठ को /* और */ के बीच रखें। SQL इंटरप्रेटर /* और */ के बीच घिरे किसी भी पाठ को नज़रअंदाज़ कर देगा।

/*
This query retrieves the employee number, first name, last name, and gender
from the 'employees' table in the 'employees' database.
It filters the results only to include male employees, limiting to 4 rows.
*/
SELECT emp_no, first_name, last_name, gender
FROM employees.employees
WHERE employees.employees.gender = 'M'
LIMIT 4;
संचालित द्वारा

SQL टिप्पणियाँ लिखने के सर्वोत्तम अभ्यास

यह सुनिश्चित करने के लिए कि आपकी टिप्पणियाँ पूरे कोडबेस में संक्षिप्त और सूचनात्मक रहें, सर्वोत्तम अभ्यासों का पालन करना महत्वपूर्ण है। आइए नीचे कुछ दिशानिर्देशों की समीक्षा करें। 

स्पष्टता और पठनीयता

अपनी टिप्पणियों में अत्यधिक जटिल या तकनीकी शब्दों का उपयोग करने से बचें। इससे वे स्पष्ट और संक्षिप्त रहेंगी ताकि कोई भी व्यक्ति, भले ही वह कोडबेस से अपरिचित हो, उन्हें समझ सके।

प्रासंगिक जानकारी जोड़ें

सुनिश्चित करें कि आप जो जानकारी देते हैं वह सटीक और जिस कोड का वह वर्णन करती है उससे सीधे संबंधित हो। यह जटिल लॉजिक के पीछे का तर्क समझाए। टिप्पणियों में पासवर्ड और API कुंजियों जैसी संवेदनशील जानकारी शामिल करने से बचें।

नियमित रूप से अपडेट करें

पुरानी टिप्पणियाँ गुमराह कर सकती हैं और तकनीकी कर्ज़ बढ़ा सकती हैं। इसलिए, जब भी आप कोड अपडेट करें, टिप्पणियों की समीक्षा और अद्यतन करें ताकि वे नवीनतम बदलावों को दर्शाएँ।

अनावश्यक पुनरावृत्ति से बचें

टिप्पणियाँ केवल यह न दोहराएँ कि कोड क्या कर रहा है। इसके बजाय, टिप्पणियाँ कोड के "क्यों" को समझाएँ—वह उद्देश्य या संदर्भ जो कोड से तुरंत स्पष्ट नहीं होता।

SQL में टिप्पणी करते समय आम गलतियाँ

अपने SQL कोड पर टिप्पणी करना चीज़ों को व्यवस्थित और समझने योग्य रखने के लिए बेहद महत्वपूर्ण है, खासकर जब आपको महीनों बाद अपने कोड पर लौटना हो। लेकिन अच्छी मंशा के बावजूद, ऐसी गलतियाँ करना आसान है जो टिप्पणियों को मददगार होने के बजाय उलझाऊ बना देती हैं। यहाँ कुछ आम गलतियाँ हैं जिनसे SQL टिप्पणियाँ लिखते समय बचना चाहिए:

अस्पष्ट या भ्रामक टिप्पणियाँ

संक्षिप्त और स्पष्ट टिप्पणियाँ लिखें जो पाठक के लिए मूल्य जोड़ें। अस्पष्ट या गलत टिप्पणियाँ, टिप्पणियाँ न होने से भी बदतर होती हैं।

अत्यधिक टिप्पणी करना

यद्यपि टिप्पणियाँ सहायक होती हैं, बहुत अधिक टिप्पणी करना कोड को पढ़ना और बनाए रखना कठिन बना सकता है। उच्च-स्तरीय उद्देश्य और कोड के गैर-स्पष्ट पहलुओं को समझाने पर ध्यान देने की कोशिश करें।

आइए एक खराब उदाहरण देखें:

SQL क्वेरी में टिप्पणी। चित्र: लेखक।

जैसा कि हम देख सकते हैं, क्योंकि हमारी वेरिएबल्स के नाम स्पष्ट थे, टिप्पणियाँ बिना अतिरिक्त संदर्भ दिए या उद्देश्य समझाए केवल कोड को ही दोहरा रही थीं।

असंगत टिप्पणी शैली

असंगत शैलियाँ ध्यान भंग करती हैं और कोड को पढ़ना कठिन बनाती हैं। इससे बचने के लिए, अपने पूरे कोडबेस में एक समान टिप्पणी शैली अपनाएँ। 

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

संदर्भ की कमी

निम्न उदाहरण में हमारे SQL कोड के उद्देश्य का उच्च-स्तरीय वर्णन शामिल है: "रिपोर्टिंग के लिए ग्राहक ऑर्डर प्राप्त करें।" यद्यपि सटीक है, यह पाठक को कोड पूर्णतः समझने में सहायता हेतु आवश्यक संदर्भ से वंचित है।

/*
* Retrieve employees' data for reporting
*/
SELECT e.first_name, e.last_name, s.salary
FROM employees.employees e
JOIN employees.salaries s ON e.emp_no = s.emp_no
WHERE s.salary > 150000
ORDER BY s.salary DESC;
संचालित द्वारा

अपनी टिप्पणी में सुधार करने के लिए, हम इसे अधिक विवरण सहित अपडेट कर सकते हैं।

/* Retrieve employees' names and salaries where salary is above $150,000
as part of the monthly HR reporting process.
*/
SELECT e.first_name, e.last_name, s.salary
FROM employees.employees e
JOIN employees.salaries s ON e.emp_no = s.emp_no
WHERE s.salary > 150000
ORDER BY s.salary DESC;
संचालित द्वारा

SQL टिप्पणियों के उन्नत उपयोग

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

मेटाडेटा एम्बेड करना

आप SQL कोड के बारे में मेटाडेटा, जैसे लेखक का नाम और निर्माण या संशोधन की तिथि, टिप्पणियों में शामिल कर सकते हैं।

/*
Author: DataCamp
Date: 2024-05-28
Purpose: Retrieve employees' credentials for their record
*/
SELECT emp_no, first_name, last_name
FROM employees.employees
संचालित द्वारा

SQL कोड डीबग करना

आप अपने SQL कोड के कुछ हिस्सों को टिप्पणी में बदलकर विशिष्ट भागों को अलग कर परीक्षण कर सकते हैं। इससे यह पता लगाने में मदद मिलती है कि समस्या कहाँ हो रही है।

/*SELECT * FROM Customers;
SELECT * FROM Products;
SELECT * FROM Orders;*/
SELECT * FROM Categories;
संचालित द्वारा

कोड को अस्थायी रूप से निष्क्रिय करना

आप सिंगल-लाइन टिप्पणियों (--) या SQL में मल्टीलाइन टिप्पणियों (/* ... */) का उपयोग करके SQL कोड को अस्थायी रूप से निष्क्रिय कर सकते हैं। इस तरह, आप कोड को क्वेरी में रख सकते हैं बिना उसे निष्पादित किए, जो आपके SQL कोड के केवल विशिष्ट भागों का परीक्षण करने में सहायक होता है।

SELECT column1, column2
FROM table1
WHERE condition1
/*
AND condition2
OR condition3
*/
संचालित द्वारा

धारणाएँ और भ्रांतियाँ

व्यापक उपयोग के बावजूद, SQL टिप्पणियों के बारे में कुछ लगातार मिथक और भ्रांतियाँ मौजूद हैं।

समापन विचार

भले ही यह SQL विकास में मामूली लग सकता है, टिप्पणियाँ कोड को बेहतर बनाती हैं और उसे समझना आसान करती हैं। स्पष्ट और सुव्यवस्थित टिप्पणियाँ लिखकर, डेवलपर्स सुनिश्चित कर सकते हैं कि उनका SQL कोड अपनी रचना के वर्षों बाद भी सुलभ बना रहे।

यदि आप अभी SQL यात्रा शुरू कर रहे हैं, तो SQL Fundamentals जैसे कोर्स के माध्यम से बुनियादी बातें समझना आपको प्रारंभ में ही टिप्पणी करने के महत्व को समझने में मदद करेगा। आगे बढ़ते हुए, SQL Associate Certification आपकी कौशल की पुष्टि करता है और दिखाता है कि आप स्पष्ट, अच्छी तरह से प्रलेखित कोड लिख सकते हैं। अपनी क्षमताओं को और निखारने के लिए, Intermediate SQL अधिक जटिल क्वेरी पर गहराई से जाता है, जहाँ डिबगिंग जैसी चीज़ों के लिए विस्तृत टिप्पणियों का उपयोग किया जा सकता है।