Skip to content

Commit 8725656

Browse files
authored
Update article.md
1 parent b90bfda commit 8725656

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
## खराब टिप्पणियाँ
1010

11-
नौसिखिए "कोड में क्या हो रहा है" समझाने के लिए टिप्पणियों का उपयोग करते हैं। इस कदर:
11+
नौसिखिए "कोड में क्या हो रहा है" समझाने के लिए टिप्पणियों का उपयोग करते हैं। उदाहरण के लिए:
1212

1313
```js
1414
// यह कोड यह काम करेगा (...) और वह काम (...)
@@ -119,16 +119,16 @@ function addJuice(container) {
119119

120120
इसलिए, व्याख्यात्मक टिप्पणियां आमतौर पर खराब होती हैं। कौन सी टिप्पणियाँ अच्छी हैं?
121121

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

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

128128
उदाहरण के लिए:
129129
```js
130130
/**
131-
* Returns x को बढ़ाकर n-वें घात पर लौटाता है।
131+
* x को बढ़ाकर n-वें घात पर लौटाता है।
132132
*
133133
* @param {number} x संख्या बढ़ाने के लिए।
134134
* @param {number} n घात, एक प्राकृत संख्या होनी चाहिए।
@@ -155,7 +155,7 @@ function pow(x, n) {
155155
2. आप सोचते हैं: "मैं तब कितना मूर्ख था, और अब मैं कितना होशियार हूं", और "अधिक स्पष्ट और सही" संस्करण का उपयोग करके फिर से लिखें।
156156
3. ...फिर से लिखने की ललक अच्छी थी। लेकिन इस प्रक्रिया में आप देखते हैं कि वास्तव में "अधिक स्पष्ट" समाधान की कमी है। आपको यह भी याद नहीं है कि क्यों, क्योंकि आप इसे बहुत पहले ही आजमा चुके हैं। आप सही संस्करण पर वापस जाते हैं, लेकिन समय बर्बाद होता है।
157157

158-
समाधान की व्याख्या करने वाली टिप्पणियाँ बहुत महत्वपूर्ण हैं। वे विकास को सही तरीके से जारी रखने में मदद करते हैं।
158+
समाधान की व्याख्या करने वाली टिप्पणियाँ बहुत महत्वपूर्ण हैं। वे development को सही तरीके से जारी रखने में मदद करते हैं।
159159

160160
कोड की कोई सूक्ष्म विशेषताएं? उनका उपयोग कहाँ किया जाता है?
161161
: यदि कोड में कुछ भी सूक्ष्म और प्रति-सहज ज्ञान युक्त है, तो यह निश्चित रूप से टिप्पणी करने योग्य है।

0 commit comments

Comments
 (0)