مستندات کد

استفاده تجاری ص ۳۸۰. بدون نشان آبی نیازی به ثبت نام نیست
مدل:
+ GPT-5, Claude, Gemini
کد را بچسبانید (یا یک پرونده را بارگذاری کنید) و رشته‌های متنی در خط، توضیحات آگاه از نوع و یک README اختیاری را دریافت کنید — در ۵ سبک انتخابی شما (Google، NumPy، reST/Sphinx، JSDoc، plain).
بدنه کد دست نخورده
Ctrl+Enter برای ارسال · Tab برای درج فضاها 0 / 12,000

یک فایل منبع (تا ۵۰۰ کیلوبایت) را رها کنید — ما آن را در زمینه کد می‌چسبانیم.

توکن بخر
کد را به سند بچسبانید.
کد مستند
کدنویس

        
گامهای بعدی
گزینه‌های پیشرفته
نتیجه
. رمزها کم ميشه گرفتن نشانه‌های بیشتر
نتيجه بهتري ميخواي؟ مدلهای پریمیوم (GPT-5, Claude, Gemini) کیفیت بالاتری را ارائه می‌دهند. نمایش نقشه

❤️ دوست Free.ai رو به دوستانت بگو

ثبت نام کنید تا لینک پیشنهادی دریافت کنید و 30 توکن برای هر دوست بدست آورید.

بيشتر ميخواي؟ ثبت نام مجاني براي 30K توکن/روز + 10K بونوس
ثبت نام

در حال پردازش درخواست شما...

مستندات کد را با هوش مصنوعی آزاد تولید کنید. رشته‌های مستندات، توضیحات و مستندات API.

چطور استفاده کنم مستندات کد

1
وارد کردن ورودی

متن را تایپ کنید ، یک پرونده را بارگذاری کنید ، یا آنچه را که می‌خواهید توصیف کنید. حساب نیازی نیست.

2
ایجاد را بزنید

هوش مصنوعی ما درخواست شما را در چند ثانیه با استفاده از بهترین مدل‌های منبع باز پردازش می‌کند.

3
بارگیری و اشتراک

دانلود، کپی یا اشتراک‌گذاری نتایج خود. برای استفاده شخصی و تجاری رایگان است.

استفاده از این ابزار از طریق API

این ابزار را از کد خودتان خودکار کنید. نقطه پایانی REST سازگار با OpenAI، گواهی‌نامه حامل گواهی‌نامه، نیازی به SDK اضافی نیست. هزینه گواهی‌نامه با رابط وب مطابقت دارد.

curl -X POST https://api.free.ai/v1/chat/ \
  -H "Authorization: Bearer sk-free-..." \
  -H "Content-Type: application/json" \
  -d '{"model": "qwen-coder", "messages": [{"role": "user", "content": "Write a Python function that reverses a string."}]}'

مستندات کد — FAQ

متن را بچسبانید (یا یک پرونده تا ۵۰۰ کیلوبایت را بارگذاری کنید) و همان کد را با رشته‌های مستندات ، توضیحات حساس به نوع ، و — به صورت اختیاری — یک README. md و مرجع API. md دریافت کنید. یکی از ۵ سبک رشته مستندات (Google / NumPy / reST- Sphinx / JSDoc- TSDoc / plain) و ۵ دامنه خروجی (فقط رشته‌های مستندات ، + در خط ، + README ، + API ref ، بسته کامل) را انتخاب کنید. بدنه کد بایت به بایت یکسان باقی می‌ماند؛ فقط رشته‌های مستندات و توضیحات اضافه می‌شوند.

Mintlify Writer is a free VSCode extension that does inline docstrings only — no README, no API ref. DocuWriter.ai charges $19/mo for unlimited and gates style-switching behind paid tiers. Tabnine adds short summaries inline as part of its $12/mo Pro plan. Free.ai runs through the daily token pool with no monthly subscription, supports all 5 styles in the free tier, and can emit a README + full API reference in one shot which the IDE plugins cannot.

نه — هشدار سیستم تغییر نام ، تغییر ترتیب یا تغییر هر منطقی را ممنوع می‌کند. فقط رشته‌های مستندات و توضیحات اضافه می‌شوند. نمای »اصلی« در قاب نتیجه به شما اجازه می‌دهد با تغییر به عقب تأیید کنید؛ نسخه مستند شده را با اطمینان به پرونده خود رونوشت و چسبانید.

Google for Python projects new in 2018+ (mkdocs / pdoc render it cleanly). NumPy for scientific Python (matplotlib, scikit-learn convention). reST/Sphinx for Python projects already on Sphinx autodoc. JSDoc/TSDoc for JavaScript/TypeScript (works with VSCode IntelliSense and TypeDoc). plain when you want one short comment line per function and no formal blocks.

بله — دامنه "Docstrings + README.md" یا "Full pack" را انتخاب کنید. README شامل نام پروژه، یک خط شعار، دستور نصب (pip / npm / cargo / go-get که از زبان استنباط شده)، شروع سریع ۳۰ ثانیه، فراخوان کلید API، و یک جایگزین مجوز است. برای یک کپی README با کیفیت بازاریابی غنی تر، بعد از آن ابزار /code/readme/ را به زنجیره بزنید.

مرجع API (Markdown) هر نماد عمومی را بر اساس پرونده/ کلاس با امضای، هدف، پارامترها، بازگشت‌ها و یک فراخوان مثال فهرست می‌کند — آماده برای چسباندن به پوشه `docs/`، ReadTheDocs، یا یک سایت GitHub Pages. رشته‌های در خط docstrings در خود کد زندگی می‌کنند. برای گرفتن هر دو در یک زمان، «پاکت کامل» را انتخاب کنید.

Qwen 3 Coder (به صورت پیش‌فرض، مجموعهٔ رایگان) ~۹۵٪ از فایل‌های زیر ۲۰۰ خط را به خوبی مدیریت می‌کند. DeepSeek R1 برای فایل‌هایی که شما می‌خواهید استدلال عمیق در مورد موارد کناری که docstring باید اشاره کند. Premium Claude Sonnet 4 / GPT-5 برای مستندات بستهٔ کامل بیش از ۱۰۰۰ خط اجرا می‌کند - آنها بافت بزرگتری دارند و سبک پایدارتری را در تمام فایل‌ها تولید می‌کنند.

بله — هنگامی که «افزودن اطلاعات نوع» علامت زده می‌شود، مدل از یادداشت‌های موجود در مورد نوع استفاده می‌کند و از استفاده از نوع‌های منطقی استنباط می‌کند. انواع استنباط شده به روشنی در رشتهٔ مستندات (قسمت Argus / برچسب @param) قرار می‌گیرند تا قابل بازبینی باقی بمانند. یادداشت‌های واقعی کد توسط مستندات کد اضافه نمی‌شوند — برای این کار از /code/refactor/ با هدف «نوع ایمنی» استفاده کنید.

در هر تماس، تا ۱۲۰۰۰ کاراکتر (~۱۸۰ خط) را چسباندن. برای پروژه‌های چند پرونده‌ای، پرونده‌ای به پرونده‌ای اجرا کنید (کد یکسانی را از طریق مستندات کد زنجیر کنید، سپس برای گرفتن تست‌های نسخه مستند شده بر روی «تولید تست‌ها» کلیک کنید). یا از API برای کارهای دسته ای استفاده کنید — POST به /v1/chat/ در یک حلقه.

Code is sent to the model, processed, and discarded. Not stored, not used for training. For maximum privacy pick Qwen 3 Coder — self-hosted on our GPUs, your code never leaves Free.ai infrastructure. External premium models (Claude, GPT-5) route through their respective providers under their data-handling terms.

پایتون، جاوااسکریپت، تایپسکریپت، جاوا، سی++، سی، سی#، گو، راست، روبی، پی‌اچ‌پی، سویفت، کاتلین، شل/باش، اس‌کیوال، اچ‌تی‌ام‌ال/سی‌اس‌اس — ۱۶+ در انتخاب‌کننده، با تشخیص خودکار برای هر چیزی که مدل تشخیص می‌دهد (Lua، Elixir، Haskell، Scala، Dart، R، MATLAB، Perl).

بله — POST به /v1/chat/ با دستورالعمل سیستم مستندات (سبک + محدوده + اضافات) و کد به عنوان پیام کاربر. برای وصل کردن مستندات به یک گام CI یا یک hook پیش از commit مفید است. برای نگاشته‌ها /api/ را ببینید.

براي 30000 تا توکن مجاني ثبت نام کن

ایجاد حساب

کارت اعتباري لازم نيست

اين ابزار رو چطور رتبه بندي ميکني؟

5.0/5 from 1 rating

دوست Free.ai رو به دوستانت بگو