JS टिप्पणियाँ
In this page:
// single-line comment
/* multi-line
comment */
Single Line Comments
Single line comment दो forward slashes // से शुरू होता है, और उस बिंदु से line के अंत तक सब कुछ JavaScript engine द्वारा अनदेखा कर दिया जाता है।
उदाहरण: Single Line Comments
// This line explains the code below
let age = 25;
console.log(age);
Multi Line Comments
Multi line comment /* से शुरू होकर */ पर खत्म होता है, जिससे comment कई lines में फैल सकता है, जो लंबी व्याख्याओं या code के किसी block को अस्थायी रूप से अक्षम करने के लिए उपयोगी है।
उदाहरण: Multi Line Comments
/*
This is a longer explanation
spanning multiple lines.
*/
console.log("Done");
Code को Comment Out करना
Comments का आमतौर पर उपयोग किसी line या code के block को बिना मिटाए अस्थायी रूप से अक्षम करने के लिए होता है, जो debugging या वैकल्पिक तरीकों को आज़माते समय उपयोगी है।
उदाहरण: Commenting Out Code
console.log("This runs");
// console.log("This is disabled for testing");
उपयोगी Comments लिखना
सबसे मूल्यवान comments यह समझाते हैं कि code का कोई टुकड़ा क्यों मौजूद है या कोई विशेष तरीका क्यों चुना गया, क्योंकि code खुद पहले से दिखाता है कि वह क्या करता है, comments को वह संदर्भ जोड़ना चाहिए जो अकेले पढ़ने से स्पष्ट नहीं होता।
उदाहरण: Writing Useful Comments
// Using 0.9 because the API rounds up otherwise
const threshold = 0.9;
console.log(threshold);
JSDoc की बुनियाद
JSDoc एक संरचित comment शैली है, जो /** से शुरू होती है, और किसी function के उद्देश्य, parameters और return value को मानकीकृत रूप में दस्तावेज़ित करती है, जिसे कई editors और tools पढ़कर उपयोगी संकेत दे सकते हैं।
उदाहरण: JSDoc Basics
/**
* Adds two numbers together.
* @param {number} a
* @param {number} b
* @returns {number}
*/
function add(a, b) {
return a + b;
}
console.log(add(2, 3));
- ऐसे comments लिखना जो सिर्फ यह दोहराते हैं कि code obviously क्या करता है, यह बताने के बजाय कि वह ऐसा क्यों करता है।
- किसी multi-line comment को */ से close करना भूल जाना, जो अनजाने में बाद के सारे code को comment out कर देता है।
- बिना इस्तेमाल के purane, commented-out code के बड़े blocks को file में हमेशा के लिए छोड़ देना, unused code delete करने के बजाय उसे बिखेर देना।
- Single-line comments // से शुरू होते हैं, और उस line पर उनके बाद सब कुछ नजरअंदाज कर दिया जाता है।
- Multi-line comments /* और */ में wrap होते हैं, और जितनी लाइनें चाहिए उतनी span कर सकते हैं।
- Comments tricky logic explain करने और testing के दौरान code temporarily disable करने के लिए उपयोगी हैं।
// और /* */ दोनों comment syntax core JavaScript का हिस्सा हैं और हर browser और JavaScript engine द्वारा समान रूप से supported हैं।
Chapter Quiz — Complete all 12 topics to unlock
0/12 topics done
Complete these topics first: