PHP Comments

PHP में कमेंट्स (Comments) का उपयोग कोड में नोट्स या व्याख्या जोड़ने के लिए किया जाता है। कमेंट्स को PHP इंजन द्वारा नजरअंदाज कर दिया जाता है, यानी वे कोड के आउटपुट में नहीं दिखते। ये डेवलपर्स के लिए उपयोगी होते हैं, ताकि कोड को समझना और मेंटेन करना आसान हो। इस चैप्टर में, हम PHP में कमेंट्स के प्रकार, उनके उपयोग, और बेस्ट प्रैक्टिसेज सीखेंगे।

PHP कमेंट्स क्या हैं?

कमेंट्स कोड का वह हिस्सा हैं जो प्रोग्राम के रन होने पर निष्पादित (execute) नहीं होता। इनका उपयोग निम्नलिखित के लिए होता है:

• कोड के उद्देश्य को समझाने के लिए।
• कोड के जटिल हिस्सों की व्याख्या करने के लिए।
• डिबगिंग के दौरान कोड के कुछ हिस्सों को अस्थायी रूप से अक्षम करने के लिए।
• टेक्निकल नोट्स या टू-डू लिस्ट जोड़ने के लिए।

PHP में दो प्रकार के कमेंट्स होते हैं:

1. सिंगल-लाइन कमेंट्स (Single-Line Comments)
2. मल्टी-लाइन कमेंट्स (Multi-Line Comments)

---

सिंगल-लाइन कमेंट्स

सिंगल-लाइन कमेंट्स का उपयोग एक ही पंक्ति में टिप्पणी लिखने के लिए होता है। PHP में इसके लिए दो तरीके हैं:

• //: C++ स्टाइल कमेंट।
• #: Shell स्टाइल कमेंट (कम उपयोग होता है)।

उदाहरण:

<?php
// यह एक सिंगल-लाइन कमेंट है
$name = "राहुल"; // यह वेरिएबल यूजर का नाम स्टोर करता है
# यह भी एक सिंगल-लाइन कमेंट है
echo $name;
?>

आउटपुट:

राहुल

विश्लेषण:

• // और # के बाद लिखा गया टेक्स्ट PHP द्वारा नजरअंदाज किया जाता है।
• कमेंट केवल उसी लाइन तक लागू होता है, अगली लाइन पर कोड सामान्य रूप से चलता है।
• सिंगल-लाइन कमेंट्स छोटी टिप्पणियों के लिए उपयोगी हैं।

---

मल्टी-लाइन कमेंट्स

मल्टी-लाइन कमेंट्स का उपयोग कई पंक्तियों में टिप्पणी लिखने के लिए होता है। इसके लिए /* और */ का उपयोग किया जाता है।

उदाहरण:

<?php
/*
यह एक मल्टी-लाइन कमेंट है।
इसका उपयोग कोड के बड़े हिस्सों की व्याख्या के लिए होता है।
यहाँ आप कई पंक्तियों में नोट्स लिख सकते हैं।
*/
$age = 25;
echo "उम्र: $age";
?>

आउटपुट:

उम्र: 25

विश्लेषण:

• /* कमेंट की शुरुआत और */ कमेंट की समाप्ति दर्शाता है।
• इसके बीच लिखा गया कोई भी टेक्स्ट PHP द्वारा नजरअंदाज किया जाता है।
• मल्टी-लाइन कमेंट्स लंबी व्याख्या या कोड के बड़े हिस्सों को अक्षम करने के लिए उपयोगी हैं।

---

Try It Yourself: सिंगल-लाइन और मल्टी-लाइन कमेंट्स

1. कोड लिखें:

• अपने कोड एडिटर में नई फाइल बनाएँ और इसे comments.php नाम से C:\xampp\htdocs में सेव करें।
• निम्नलिखित कोड कॉपी करें:

   <?php
   // यह कोड यूजर की जानकारी प्रिंट करता है
   $name = "अनिता";
   $city = "मुंबई";

   /*
   नीचे दिया गया कोड यूजर का नाम और शहर प्रिंट करता है।
   यह एक साधारण उदाहरण है।
   */
   echo "नाम: $name, शहर: $city";
   ?>

2. ब्राउज़र में देखें:

• XAMPP में Apache सर्वर शुरू करें।
• ब्राउज़र में http://localhost/comments.php खोलें।
• आउटपुट:
  नाम: अनिता, शहर: मुंबई

विश्लेषण:

• कमेंट्स आउटपुट में नहीं दिखते, लेकिन कोड को पढ़ने में मदद करते हैं।
• आप इस कोड में और कमेंट्स जोड़कर प्रैक्टिस कर सकते हैं।

---

कमेंट्स का उपयोग कब करें?

1. कोड की व्याख्या:

• जटिल लॉजिक को समझाने के लिए।
• उदाहरण:
  php // यह फंक्शन यूजर की उम्र की गणना करता है $birthYear = 1995; $currentYear = 2025; $age = $currentYear - $birthYear;

1. डिबगिंग:

• कोड के कुछ हिस्सों को टेस्टिंग के लिए अक्षम करने के लिए।
• उदाहरण:
  php <?php $total = 100; // echo "टोटल: $total"; // इस लाइन को डिबगिंग के लिए कमेंट किया गया echo "कोड चल रहा है"; ?>

1. डॉक्यूमेंटेशन:

• प्रोजेक्ट में कोड के उद्देश्य, लेखक, या वर्जन की जानकारी जोड़ने के लिए।
• उदाहरण:
  php /* फाइल: user_profile.php लेखक: राहुल शर्मा तारीख: 25 जून 2025 उद्देश्य: यूजर प्रोफाइल डेटा को प्रोसेस करना */

1. टू-डू नोट्स:

• भविष्य में कोड में सुधार या बदलाव के लिए नोट्स।
• उदाहरण:
  php // TODO: यूजर इनपुट वेलिडेशन जोड़ना $username = $_POST['username'];

---

कमेंट्स से संबंधित बेस्ट प्रैक्टिसेज

1. स्पष्ट और संक्षिप्त रहें:

• कमेंट्स में केवल जरूरी जानकारी लिखें।
• गलत: // यह वेरिएबल है
• सही: // यूजर का नाम स्टोर करता है

1. अतिरिक्त कमेंट्स से बचें:

• स्पष्ट कोड के लिए कमेंट्स की जरूरत नहीं।
• उदाहरण:
  php $count = 10; // $count को 10 असाइन किया गया (जरूरी नहीं)

1. कमेंट्स को अपडेट रखें:

• अगर कोड बदलता है, तो संबंधित कमेंट्स को भी अपडेट करें।
• पुराने कमेंट्स भ्रम पैदा कर सकते हैं।

1. डॉक्यूमेंटेशन कमेंट्स:

• बड़े प्रोजेक्ट्स में PHPDoc स्टाइल कमेंट्स का उपयोग करें (एडवांस्ड टॉपिक)।
• उदाहरण: “`php /**
  • यह फंक्शन दो संख्याओं का योग लौटाता है
  • @param int $a पहली संख्या
  • @param int $b दूसरी संख्या
  • @return int योग
    */
    function add($a, $b) {
    return $a + $b;
    }
    “`

1. टीम प्रोजेक्ट्स में स्टैंडर्ड्स:

• अगर आप टीम में काम कर रहे हैं, तो कमेंटिंग स्टाइल पर सहमति बनाएँ।

---

सामान्य गलतियाँ और समाधान

1. कमेंट्स का गलत क्लोजिंग:

• मल्टी-लाइन कमेंट में */ भूलने से एरर आ सकता है।
• गलत:
  php /* यह एक कमेंट है echo "हैलो"; // एरर, क्योंकि */ मिसिंग है ?>
• सही:
  php /* यह एक कमेंट है */ echo "हैलो";

1. कमेंट्स में कोड लिखना:

• कमेंट्स में कोड लिखने से भ्रम हो सकता है।
• गलत:
  php // echo "यह पुराना कोड था";
• सही: पुराने कोड को हटाएँ या अलग फाइल में सेव करें।

1. कमेंट्स का दुरुपयोग:

• जरूरत से ज्यादा कमेंट्स कोड को अव्यवस्थित बना सकते हैं।
• केवल जरूरी जगहों पर कमेंट्स लिखें।

---

Try It Yourself: डिबगिंग के लिए कमेंट्स

1. कोड लिखें:

• फाइल debug_comments.php बनाएँ और निम्नलिखित कोड कॉपी करें:

   <?php
   $price = 100;
   $discount = 20;
   // $finalPrice = $price - $discount; // डिबगिंग के लिए कमेंट किया गया
   $finalPrice = $price; // डिस्काउंट लागू नहीं किया गया
   echo "फाइनल प्राइस: $finalPrice";
   ?>

2. ब्राउज़र में देखें:

• http://localhost/debug_comments.php खोलें।
• आउटपुट:
  फाइनल प्राइस: 100

2. प्रैक्टिस:

• अब कमेंट की गई लाइन को अनकमेंट करें (// हटाएँ) और $finalPrice = $price; को कमेंट करें।
• आउटपुट क्या होगा? (जवाब: फाइनल प्राइस: 80)

---

अतिरिक्त टिप्स

• कमेंट्स का उपयोग डिबगिंग टूल के साथ करें: PHP में var_dump() या print_r() का उपयोग करके वेरिएबल्स चेक करें और कमेंट्स में नोट्स जोड़ें।
• कोड रीडेबिलिटी: कमेंट्स के साथ-साथ वेरिएबल्स के अर्थपूर्ण नाम (जैसे $userName बजाय $n) का उपयोग करें।
• IDE फीचर्स: VS Code जैसे एडिटर्स में Ctrl + / दबाकर लाइन को तुरंत कमेंट/अनकमेंट करें।