Skip to content

टिप्पणी हटाना

Repomix आपको आउटपुट से कोड टिप्पणियां हटाने की अनुमति देता है। यह सुविधा टोकन उपयोग को कम करने और AI मॉडल के लिए आउटपुट को अधिक संक्षिप्त बनाने में मदद कर सकती है।

टिप्पणियां हटाने का उपयोग

टिप्पणियां हटाने के लिए, --remove-comments विकल्प का उपयोग करें:

bash
repomix --remove-comments

आप इसे अन्य विकल्पों के साथ संयोजित कर सकते हैं:

bash
repomix --remove-comments --style markdown --output-file output.md

कॉन्फिगरेशन फाइल में टिप्पणियां हटाना

आप अपने repomix.config.json में टिप्पणियां हटाने को कॉन्फिगर कर सकते हैं:

json
{
  "processing": {
    "removeComments": true
  }
}

समर्थित टिप्पणी प्रकार

Repomix निम्नलिखित प्रकार की टिप्पणियों को हटा सकता है:

सिंगल-लाइन टिप्पणियां

javascript
// यह एक सिंगल-लाइन टिप्पणी है
const x = 5; // लाइन के अंत में टिप्पणी

मल्टी-लाइन टिप्पणियां

javascript
/*
 * यह एक मल्टी-लाइन टिप्पणी है
 * जो कई लाइनों पर फैली हुई है
 */
const y = 10;

डॉक्यूमेंटेशन टिप्पणियां

javascript
/**
 * एक फंक्शन जो दो संख्याओं को जोड़ता है
 * @param {number} a - पहली संख्या
 * @param {number} b - दूसरी संख्या
 * @returns {number} - दोनों संख्याओं का योग
 */
function add(a, b) {
  return a + b;
}

HTML/XML टिप्पणियां

html
<!-- यह एक HTML टिप्पणी है -->
<div>कंटेंट</div>

पायथन टिप्पणियां

python
# यह एक पायथन टिप्पणी है
x = 5  # लाइन के अंत में टिप्पणी

"""
यह एक मल्टी-लाइन
पायथन डॉकस्ट्रिंग है
"""

टिप्पणियां हटाने के लाभ

टिप्पणियां हटाने के कई लाभ हैं:

  1. टोकन उपयोग कम करना: टिप्पणियां हटाकर, आप AI मॉडल के लिए आवश्यक टोकन की संख्या कम कर सकते हैं
  2. शोर कम करना: टिप्पणियां हटाकर, आप AI मॉडल के लिए आउटपुट को अधिक संक्षिप्त और केंद्रित बना सकते हैं
  3. संवेदनशील जानकारी हटाना: टिप्पणियां अक्सर संवेदनशील जानकारी या व्यक्तिगत नोट्स शामिल कर सकती हैं

टिप्पणियां हटाने के नुकसान

टिप्पणियां हटाने के कुछ नुकसान भी हैं:

  1. संदर्भ का नुकसान: टिप्पणियां अक्सर कोड के बारे में महत्वपूर्ण संदर्भ या स्पष्टीकरण प्रदान करती हैं
  2. डॉक्यूमेंटेशन का नुकसान: डॉक्यूमेंटेशन टिप्पणियां फंक्शन, पैरामीटर और रिटर्न वैल्यू के बारे में महत्वपूर्ण जानकारी प्रदान करती हैं
  3. कोड समझने में कठिनाई: टिप्पणियों के बिना, AI मॉडल को कोड का उद्देश्य समझने में कठिनाई हो सकती है

कब टिप्पणियां हटाएं

निम्नलिखित परिस्थितियों में टिप्पणियां हटाना उपयोगी हो सकता है:

  1. टोकन सीमाओं से निपटना: जब आप AI मॉडल की टोकन सीमाओं से निपट रहे हों
  2. केवल कोड पर ध्यान केंद्रित करना: जब आप चाहते हैं कि AI मॉडल केवल कोड पर ध्यान केंद्रित करे
  3. संवेदनशील जानकारी हटाना: जब टिप्पणियों में संवेदनशील जानकारी शामिल हो

कब टिप्पणियां न हटाएं

निम्नलिखित परिस्थितियों में टिप्पणियां बनाए रखना बेहतर हो सकता है:

  1. जटिल कोड: जब कोड जटिल हो और टिप्पणियां महत्वपूर्ण स्पष्टीकरण प्रदान करती हों
  2. API डॉक्यूमेंटेशन: जब टिप्पणियां API डॉक्यूमेंटेशन के लिए महत्वपूर्ण हों
  3. कोड समझना: जब आप चाहते हैं कि AI मॉडल कोड के उद्देश्य और कार्यप्रणाली को समझे

उदाहरण

टिप्पणियों के साथ कोड

javascript
/**
 * उपयोगकर्ता को प्रमाणित करता है
 * @param {string} username - उपयोगकर्ता का नाम
 * @param {string} password - उपयोगकर्ता का पासवर्ड
 * @returns {boolean} - प्रमाणीकरण सफल था या नहीं
 */
function authenticateUser(username, password) {
  // डेटाबेस से उपयोगकर्ता प्राप्त करें
  const user = getUserFromDatabase(username);
  
  // यदि उपयोगकर्ता नहीं मिला, तो false लौटाएं
  if (!user) {
    return false;
  }
  
  // पासवर्ड की जांच करें
  return checkPassword(user, password);
}

टिप्पणियों के बिना कोड

javascript
function authenticateUser(username, password) {
  const user = getUserFromDatabase(username);
  
  if (!user) {
    return false;
  }
  
  return checkPassword(user, password);
}

अगला क्या है?

Released under the MIT License.