Skip to content

Commit 2434c78

Browse files
authored
Update article.md
Updated as per review
1 parent b6f3119 commit 2434c78

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

1-js/03-code-quality/03-comments/article.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# टिप्पणियाँ
22

3-
जैसा कि हम अध्याय जानकारी:संरचना से जानते हैं, टिप्पणियाँ सिंगल-लाइन हो सकती हैं: // से शुरू, और मल्टीलाइन : /* ... */ से शुरू
3+
जैसा कि हम अध्याय <info:structure> से जानते हैं, टिप्पणियाँ सिंगल-लाइन हो सकती हैं: // से शुरू, और मल्टीलाइन : /* ... */ से शुरू
44

55
हम आमतौर पर उनका उपयोग यह वर्णन करने के लिए करते हैं कि कोड कैसे और क्यों काम करता है।
66

@@ -22,7 +22,7 @@
2222

2323
इसके बारे में एक महान नियम है: "यदि कोड इतना अस्पष्ट है कि उसे एक टिप्पणी की आवश्यकता है, तो शायद इसे इसके बजाय फिर से लिखा जाना चाहिए"।
2424

25-
### विधि: कारक बाहर कार्य
25+
### विधि: function को फ़ैक्टर आउट करें
2626

2727
कभी-कभी किसी function के साथ कोड टुकड़ा को बदलना फायदेमंद होता है, जैसे यहाँ:
2828

@@ -32,7 +32,7 @@ function showPrimes(n) {
3232
for (let i = 2; i < n; i++) {
3333

3434
*!*
35-
// check if i is a prime number जांचें कि क्या i एक प्रमुख संख्या है
35+
// जांचें कि क्या i एक प्रमुख संख्या है
3636
for (let j = 2; j < i; j++) {
3737
if (i % j == 0) continue nextPrime;
3838
}
@@ -43,7 +43,7 @@ function showPrimes(n) {
4343
}
4444
```
4545

46-
फ़ैक्टर आउट फ़ंक्शन `isPrime` के साथ बेहतर संस्करण:
46+
फ़ैक्टर आउट function `isPrime` के साथ बेहतर संस्करण:
4747

4848

4949
```js
@@ -90,7 +90,7 @@ for(let t = 0; t < 3; t++) {
9090
// ...
9191
```
9292

93-
फिर इसे कार्यों को दोबारा करने के लिए यह एक बेहतर संस्करण हो सकता है जैसे:
93+
फिर इसे करने के लिए एक बेहतर संस्करण हो सकता है functions का प्रयोग करना:
9494

9595
```js
9696
addWhiskey(glass);
@@ -111,7 +111,7 @@ function addJuice(container) {
111111
}
112112
```
113113

114-
एक बार फिर, functions स्वयं बताते हैं कि क्या हो रहा है। टिप्पणी करने के लिए कुछ भी नहीं है। और विभाजित होने पर कोड संरचना भी बेहतर होती है। यह स्पष्ट है कि प्रत्येक कार्य क्या करता है, यह क्या लेता है और यह क्या लौटाता है।
114+
एक बार फिर, functions स्वयं बताते हैं कि क्या हो रहा है। टिप्पणी करने के लिए कुछ भी नहीं है। और विभाजित होने पर कोड संरचना भी बेहतर होती है। यह स्पष्ट है कि प्रत्येक function क्या करता है, यह क्या लेता है और यह क्या लौटाता है।
115115

116116
वास्तव में, हम "व्याख्यात्मक" टिप्पणियों से पूरी तरह से बच नहीं सकते हैं। जटिल एल्गोरिदम होते हैं और अनुकूलन के प्रयोजनों के लिए चतुर "बदलाव" हैं। लेकिन आम तौर पर हमें कोड को सरल और स्व-वर्णनात्मक रखने का प्रयास करना चाहिए।
117117

@@ -123,7 +123,7 @@ function addJuice(container) {
123123
: घटकों का एक उच्च-स्तरीय अवलोकन प्रदान करें, वे कैसे बातचीत करते हैं, विभिन्न स्थितियों में नियंत्रण प्रवाह क्या है... संक्षेप में - कोड के बारे में विहंगम दृष्टि। कोड की व्याख्या करने वाले उच्च-स्तरीय आर्किटेक्चर आरेख बनाने के लिए एक विशेष भाषा [UML](http://wikipedia.org/wiki/Unified_Modeling_Language) है। निश्चित रूप से ये अध्ययन करने लायक।
124124

125125
दस्तावेज़ फ़ंक्शन पैरामीटर और उपयोग
126-
: किसी फ़ंक्शन का दस्तावेज़ीकरण करने के लिए एक विशेष सिंटैक्स [JSDoc](http://en.wikipedia.org/wiki/JSDoc) है: उपयोग, पैरामीटर, लौटाया गया मान।
126+
: किसी function का दस्तावेज़ीकरण करने के लिए एक विशेष सिंटैक्स [JSDoc](http://en.wikipedia.org/wiki/JSDoc) है: उपयोग, पैरामीटर, लौटाया गया मान।
127127

128128
उदाहरण के लिए:
129129
```js
@@ -139,9 +139,9 @@ function pow(x, n) {
139139
}
140140
```
141141

142-
इस तरह की टिप्पणियाँ हमें फ़ंक्शन के उद्देश्य को समझने और इसके कोड को देखे बिना इसका सही तरीके से उपयोग करने की अनुमति देती हैं।
142+
इस तरह की टिप्पणियाँ हमें function के उद्देश्य को समझने और इसके कोड को देखे बिना इसका सही तरीके से उपयोग करने की अनुमति देती हैं।
143143

144-
वैसे, [वेबस्टॉर्म](https://www.jetbrains.com/webstorm/) जैसे कई संपादक उन्हें भी समझ सकते हैं और स्वत: पूर्ण और कुछ स्वचालित कोड-जांच प्रदान करने के लिए उनका उपयोग कर सकते हैं।
144+
वैसे, [WebStorm](https://www.jetbrains.com/webstorm/) जैसे कई संपादक उन्हें भी समझ सकते हैं और स्वत: पूर्ण और कुछ स्वचालित कोड-जांच प्रदान करने के लिए उनका उपयोग कर सकते हैं।
145145

146146
साथ ही, [JSDoc 3](https://github.com/jsdoc3/jsdoc) जैसे टूल हैं जो टिप्पणियों से HTML-दस्तावेज़ीकरण उत्पन्न कर सकते हैं। आप JSDoc के बारे में अधिक जानकारी <http://usejsdoc.org/> पर पढ़ सकते हैं।
147147

@@ -169,7 +169,7 @@ function pow(x, n) {
169169
**यह टिप्पणी करें:**
170170

171171
- समग्र वास्तुकला, उच्च स्तरीय दृश्य।
172-
- समारोह का उपयोग।
172+
- function का उपयोग।
173173
- महत्वपूर्ण समाधान, खासकर जब तुरंत स्पष्ट न हों।
174174

175175
**टिप्पणियों से बचें:**

0 commit comments

Comments
 (0)