HTML Comments

HTML Comment क्या है?

Comments आपके code में notes होते हैं जिन्हें ब्राउज़र पूरी तरह ignore कर देता है। वे live webpage पर दिखाई नहीं देते, लेकिन खुद के और दूसरे developers के लिए instructions, explanations, या reminders छोड़ने के लिए बेहद उपयोगी होते हैं।

उदाहरण: What is an HTML Comment?

<!-- This note is invisible on the live page -->
<p>Visible content</p>

Code को अस्थायी रूप से Hide करना

जब आप debug कर रहे हों या कोई नया feature बना रहे हों, तो आप किसी element को permanently delete किए बिना छिपाना चाह सकते हैं। code को comment out करने से आप elements को safely off कर सकते हैं और जब चाहें उन्हें वापस ला सकते हैं।

उदाहरण: Hiding Code Temporarily

<!-- <p>This paragraph is temporarily hidden</p> -->
<p>This paragraph is visible</p>

बड़े Web Layouts को Organize करना

जैसे-जैसे आपकी HTML files सैकड़ों lines तक बढ़ती हैं, यह पता लगाना कि कोई specific section कहां खत्म होता है, सिरदर्द बन जाता है। Comments आपके codebase को organized और navigate करने में आसान रखने के लिए visual headers और dividing lines का काम करते हैं।

उदाहरण: Organizing Huge Web Layouts

<!-- ===== Header Section ===== -->
<header></header>
<!-- ===== Footer Section ===== -->
<footer></footer>

TODOs से दूसरों के साथ Collaborate करना

जब आप किसी team में काम कर रहे हों या future edits की planning कर रहे हों, तो आप tasks सीधे अपने markup में लिख सकते हैं। किसी comment के अंदर TODO tag जोड़ना बकाया tasks को track रखने का एक standard industry practice है।

उदाहरण: Collaborating with Others Using TODOs

<!-- TODO: add pagination controls here -->
<div></div>

Public Comments को साफ़ क्यों होना चाहिए

HTML एक client-side language है। इसका मतलब है कि आपके comments सहित हर line of code सीधे user के ब्राउज़र में भेजा जाता है। जो कोई भी आपके page पर right-click करके 'View Source' चुनता है, वह आपके developer notes पढ़ सकता है।

उदाहरण: Why Public Comments Must Be Clean

<!-- Do not leave internal notes here; anyone can View Source -->
<p>Public page content</p>

अलग-अलग Teams में Commenting Conventions

अलग-अलग teams अक्सर अपने खुद के comment conventions अपनाती हैं, जैसे महत्वपूर्ण warnings के आगे 'NOTE:' लगाना या बाद में हटाए जाने वाले sections को 'TEMP:' से mark करना।

पूरी team में एक shared convention पर सहमत होने से comments तब कहीं ज़्यादा उपयोगी बन जाते हैं जब कई लोग एक ही codebase पर काम करते हैं।

उदाहरण: Commenting Conventions Across Teams

<!-- NOTE: this section relies on the global nav script -->
<!-- TEMP: remove this banner after the sale ends -->
<div></div>