कोड समझाने वाला एजेंट
ऐसा एजेंट बनाएँ जो स्रोत फ़ाइलें पढ़े, LLM से स्पष्टीकरण माँगे और Markdown दस्तावेज़ लौटाए।
कोड समझाने वाला एजेंट, CoddyKit पर AI एजेंट का एक निःशुल्क पाठ है। यह 4 में से 2वाँ पाठ है। आप नीचे पूरा पाठ निःशुल्क पढ़ सकते हैं—फिर अंतर्निहित कोड संपादक और 24/7 एआई ट्यूटर के साथ ब्राउज़र में इसका व्यावहारिक अभ्यास कर सकते हैं। यह AI एजेंट सीखने के मार्ग का हिस्सा है और आपकी प्रगति वेब तथा CoddyKit ऐप पर सिंक होती रहती है। AI एजेंट पाठ्यक्रम में कुल 4 पाठ शामिल हैं।
इस पाठ के कुछ हिस्सों का अभी तक अनुवाद नहीं हुआ है और वे अंग्रेज़ी में दिखाए गए हैं।
प्रोजेक्ट का लक्ष्य
एक ऐसा एजेंट बनाएँ जो स्रोत फ़ाइल (Python, JS या कुछ भी) ले और Markdown दस्तावेज़ लौटाए: उद्देश्य, प्रमुख फ़ंक्शन और उपयोग का उदाहरण।
यह उपयोगी क्यों है?
कोड से दस्तावेज़ बनाना LLM के सबसे विश्वसनीय उपयोगों में से एक है — कोड संरचित होता है, कार्य सीमित होता है और परिणाम मनुष्यों द्वारा पढ़ा जाता है, इसलिए छोटी त्रुटियाँ सहनीय होती हैं।
आर्किटेक्चर
- स्रोत फ़ाइल पढ़ें
- वैकल्पिक रूप से वर्ग/फ़ंक्शन के अनुसार विभाजित करें
- हर खंड के लिए LLM से समझाने को कहें
- सबको मिलाकर एक Markdown दस्तावेज़ बनाएँ
Step 1: Read the File
import sys
with open('example.py', 'w') as f:
f.write('print("hello")\n')
path = sys.argv[1] if len(sys.argv) > 1 else 'example.py'
with open(path) as f:
code = f.read()
print(f'Read {len(code)} characters from {path}')Step 2: Prompt for Documentation
from openai import OpenAI
oai = OpenAI()
prompt = f'''
You are a senior engineer writing developer-friendly docs.
Given this source file, produce a Markdown document with:
# {path}
## Purpose
(One paragraph)
## Public API
(Each function/class with one-line description)
## Usage Example
(One short, runnable snippet)
Source:
```
{code}
```
'''
response = oai.chat.completions.create(
model='gpt-4o-mini',
messages=[{'role': 'user', 'content': prompt}],
temperature=0.2,
)
print(response.choices[0].message.content)लंबी फ़ाइलों को सँभालें
यदि फ़ाइल बहुत लंबी है, तो फ़ंक्शन के अनुसार विभाजित करें और हर फ़ंक्शन को अलग-अलग समझाएँ:
import ast
tree = ast.parse(code)
functions = [node for node in ast.walk(tree) if isinstance(node, ast.FunctionDef)]
for func in functions:
snippet = ast.unparse(func)
explain(snippet)चरण 3: परिणामों को मिलाना
बहु-खंडीय निष्पादन में, प्रत्येक फ़ंक्शन की व्याख्या को एक दस्तावेज़ में जोड़ें:
docs = []
for func_name, snippet in functions:
explanation = explain(snippet)
docs.append(f'### {func_name}\n\n{explanation}\n')
full_doc = '\n'.join(docs)
open('docs.md', 'w').write(full_doc)प्रोजेक्ट-स्तरीय सारांश जोड़ें
प्रत्येक फ़ंक्शन की व्याख्या के बाद, LLM से उच्च-स्तरीय अवलोकन माँगें:
summary_prompt = 'Summarise the purpose of this package in 3 sentences, given these function docs:\n\n' + full_doc
summary = ask(summary_prompt)बहु-भाषा समर्थन
यही प्रॉम्प्ट JS, Go, Rust आदि के लिए भी काम करता है। बेहतर परिणामों के लिए प्रॉम्प्ट में भाषा जोड़ें:
prompt = f'You are documenting {language} code. ...'अंतर-आधारित दस्तावेज़
क्रमिक अद्यतनों के लिए केवल बदली हुई फ़ाइलों पर फिर चलाएँ:
import subprocess
changed = subprocess.check_output(['git', 'diff', '--name-only', 'HEAD~1']).decode().splitlines()
for path in changed:
if path.endswith('.py'):
regenerate_doc(path)उदाहरण चलाने के लिए उपकरण का उपयोग करें
सत्यापित करें कि LLM का उपयोग उदाहरण वास्तव में चलता है — एजेंट को Python REPL उपकरण दें:
def run_python(code):
try:
exec(code, {})
return {'stdout': 'ok', 'stderr': ''}
except Exception as e:
return {'stdout': '', 'stderr': str(e)}
tools = [{'name': 'run_python', 'description': 'Execute a Python snippet and return stdout/stderr', 'parameters': {'code': 'str'}}]
broken_example = 'print(1/0)'
result = run_python(broken_example)
if result['stderr']:
print('Example failed:', result['stderr'])
fixed_example = 'print(1)'
result = run_python(fixed_example)
print('Self-corrected result:', result)
else:
print('Example ran fine:', result)
जब एजेंट मनगढ़ंत बातें बनाए
मॉडल कभी-कभी ऐसे फ़ंक्शन या आर्ग्युमेंट बना देता है जो मौजूद नहीं होते। बचाव के उपाय:
- केवल फ़ाइल की सामग्री दें (मॉडल की स्मृति नहीं)
- तापमान 0 रखें
- सत्यापन चरण रखें (उदाहरण चलाएँ, अंश का लिंट परीक्षण करें)
इसे उत्पाद में बदलें
इसे CLI के रूप में लपेटें:
# pip install -e .
# docgen src/myproject/agent.py
# Outputs docs.mdउपकरण से CI तक
इसे CI में जोड़ें: प्रत्येक PR पर बदली हुई फ़ाइलों के दस्तावेज़ फिर से बनाएँ और उन्हें वापस कमिट करें। अब आपका रिपॉज़िटरी हमेशा दस्तावेज़ीकृत रहेगा।
पूरी फ़ाइल क्यों पढ़ें?
केवल फ़ंक्शन सिग्नेचर के बजाय पूरी FULL स्रोत फ़ाइल LLM को क्यों दें?
पुनरावलोकन
30-पंक्ति का ऐसा एजेंट जो कोड को दस्तावेज़ों में बदल देता है। उपकरणों और सत्यापन के साथ इसे आसानी से विस्तृत किया जा सकता है। RAG के बाद यह एक शानदार दूसरा प्रोजेक्ट है।
एआई शिक्षक के साथ AI एजेंट सीखें — निःशुल्क
अपने ब्राउज़र में वास्तविक कोड लिखें और चलाएँ, चौबीसों घंटे एआई शिक्षक से तुरंत सहायता पाएँ, और वेब या ऐप पर वहीं से शुरू करें जहाँ आपने छोड़ा था।
- पाठ्यक्रम
- 60
- पाठ
- 239
अक्सर पूछे जाने वाले प्रश्न
क्या “कोड समझाने वाला एजेंट” पाठ निःशुल्क है?
हाँ—“कोड समझाने वाला एजेंट” का पूरा पाठ यहाँ वेब पर निःशुल्क पढ़ा जा सकता है। इंटरैक्टिव अभ्यास (अंतर्निहित कोड संपादक और 24/7 एआई ट्यूटर) करने और AI एजेंट पाठ्यक्रम का बाकी हिस्सा अनलॉक करने के लिए CoddyKit PRO लें। AI एजेंट पाठ्यक्रम में कुल 4 पाठ शामिल हैं।
“कोड समझाने वाला एजेंट” में मैं क्या सीखूँगा?
ऐसा एजेंट बनाएँ जो स्रोत फ़ाइलें पढ़े, LLM से स्पष्टीकरण माँगे और Markdown दस्तावेज़ लौटाए। आप ब्राउज़र में सीधे चलाए जाने वाले व्यावहारिक कोड के साथ AI एजेंट का अभ्यास करते हैं, और पाठ पूरा करते समय 24/7 एआई ट्यूटर आपके प्रश्नों के उत्तर देता है।
क्या AI एजेंट शुरू करने के लिए मुझे किसी अनुभव की आवश्यकता है?
पहले के अनुभव की आवश्यकता नहीं है। CoddyKit पर AI एजेंट शुरुआती से लेकर उन्नत शिक्षार्थियों तक सभी के लिए व्यवस्थित किया गया है, इसलिए आप यहीं से या शुरुआत से सीखना शुरू कर सकते हैं और अपनी गति से आगे बढ़ सकते हैं। यह 4 में से 2वाँ पाठ है।
“कोड समझाने वाला एजेंट” पाठ पूरा करने में कितना समय लगता है?
CoddyKit का अधिकांश पाठ लगभग 5–10 मिनट में पूरा हो जाता है। हर पाठ छोटा और संवादात्मक है, इसलिए आप लगातार प्रगति करते हैं और वेब या ऐप पर वहीं से सीखना जारी रख सकते हैं जहाँ आपने छोड़ा था।
क्या मैं इस AI एजेंट पाठ में कोड लिख और चला सकता हूँ?
हाँ। हर AI एजेंट पाठ में एक अंतर्निर्मित कोड संपादक शामिल है, जिससे आप सीधे अपने ब्राउज़र में वास्तविक कोड लिख और चला सकते हैं और तुरंत एआई प्रतिक्रिया पा सकते हैं—स्थानीय सेटअप की आवश्यकता नहीं है।
इस पाठ्यक्रम के सभी पाठ
- अपने दस्तावेज़ों पर प्रश्न-उत्तर बॉट
- कोड समझाने वाला एजेंट
- वेब-ब्राउज़िंग शोध एजेंट
- आपके DB के लिए SQL सहायक