epydoc - آنلاین در ابر

برنامه:

نام

epydoc - مستندات API را از رشته‌های اسناد پایتون تولید کنید

خلاصه

epydoc [اقدام] [گزینه های] اسامی...

شرح

epydoc مستندات API را برای ماژول ها و بسته های پایتون بر اساس آنها ایجاد می کند
رشته های مستند یک زبان نشانه گذاری سبک وزن به نام متن متنی می توان برای قالب بندی استفاده کرد
رشته‌های اسناد و افزودن اطلاعات در مورد فیلدهای خاص، مانند پارامترها و نمونه‌ها
متغیرها Epydoc همچنین رشته‌های مستند نوشته شده در ReStructuredText، Javadoc و
متن ساده در حال حاضر، epydoc از دو فرمت خروجی اصلی پشتیبانی می کند: HTML و LaTeX.

اسناد HTML API تولید شده توسط epydoc شامل مجموعه ای از فایل های HTML شامل:
یک صفحه اسناد API برای هر کلاس و ماژول. یک صفحه کد منبع برجسته شده با نحو
برای هر ماژول؛ یک صفحه فهرست شناسه؛ یک صفحه راهنما؛ و یک جدول مبتنی بر فریم از
فهرست. هر وقت مناسب بود، epydoc همچنین صفحات شاخص برای اشکالات تعریف شده تولید می کند
شرایط، و موارد انجام کار؛ صفحه سلسله مراتب کلاس؛ و یک صفحه سلسله مراتب بسته.

مستندات LaTeX API تولید شده توسط epydoc از یک فایل LaTeX اصلی و یک LaTeX تشکیل شده است
فایل برای هر ماژول اگر استفاده می کنید --dvi, --ps، یا --pdf , سپس epydoc خارجی فراخوانی خواهد کرد
دستورات تبدیل خروجی LaTeX به فرمت درخواستی. توجه داشته باشید که فایل های LaTeX
حاوی مستندات برای ماژول های جداگانه می تواند به عنوان فصل یا
بخش هایی از سایر اسناد لاتک با استفاده از لاتک \عبارتند از فرمان اگر مایل هستید
کلاس های فردی را در سایر اسناد لاتک قرار دهید، سپس از آن استفاده کنید - کلاس های جداگانه
گزینه ای برای تولید یک فایل LaTeX جداگانه برای هر کلاس.

epydoc همچنین می تواند برای بررسی کامل بودن اسناد API استفاده شود. به صورت پیش فرض،
بررسی می کند که هر بسته عمومی، ماژول، کلاس، متد و تابع دارای یک رشته مستند باشد
شرح. --تست ها می توان از گزینه برای تعیین تست های اضافی برای انجام استفاده کرد.

قابل تکرار ساختن رفتار - اخلاق

استفاده از تاریخ فعلی در اسناد تولید شده توسط Epydoc منجر به مستنداتی می شود که
"تکرار ناپذیر" است، به این معنی که محتوای فایل ها از بیلد به ساخت تغییر می کند
حتی اگر درخت منبع آن را نداشته باشد. برای آسان‌تر کردن ساخت‌های قابل تکرار، این
نسخه Epydoc از دو ویژگی پشتیبانی می کند: --بدون-شامل-ساخت-زمان گزینه و
SOURCE_DATE_EPOCH متغیر محیطی.

La --بدون-شامل-ساخت-زمان این گزینه زمانی قابل استفاده است که از قبل می دانید که به آن نیاز ندارید
در اسناد تولید شده خود مهر زمانی بسازید. را SOURCE_DATE_EPOCH محیط
متغیر برای استفاده توسط سیستم های بسته بندی، مانند فرآیند ساخت دبیان در نظر گرفته شده است.
سیستم های بسته بندی تنظیم خواهد شد SOURCE_DATE_EPOCH به یک مهر زمانی معقول که به نوعی است
مربوط به وضعیت درخت منبع است، و این مهر زمانی توسط Eypdoc استفاده خواهد شد
از مهر زمانی فعلی با استفاده از SOURCE_DATE_EPOCH بنابراین قابل تکرار خواهد بود.

OPTIONS

گزینه های Epydoc به شش دسته تقسیم می شوند: گزینه های اساسی، اقدامات، نسل
گزینه ها، گزینه های خروجی، گزینه های نمودار، و گزینه های مقدار بازگشتی.

BASIC OPTIONS

نام...
فهرست اشیایی که باید مستند شوند. اشیاء را می توان با استفاده از آن مشخص کرد
نام‌های نقطه‌دار پایتون (مانند مسیر os، نام فایل ها (مانند epydoc/epytext.py),
یا نام دایرکتوری ها (مانند epydoc/). نام دایرکتوری بسته ها را مشخص می کند و
گسترش یافته اند تا همه زیر ماژول ها و بسته های فرعی را شامل شوند. اگر مایل هستید
زیر ماژول ها یا بسته های فرعی خاصی را حذف کنید، از -- استثناء کردن انتخاب
(در زیر توضیح داده شده است).

- پیکربندی پرونده
یک فایل پیکربندی که موارد اضافی را مشخص می کند گزینه هایو / یانام. این گزینه
ممکن است تکرار شود

--q، --ساکت، --v، -- پرحرف
خروجی کاملاً (یا گویا) تولید کنید. اگر چندین بار استفاده شود، این گزینه
به طور متوالی خروجی آرام (یا پرمخاطب) بیشتری تولید می کند.

- رفع اشکال
نمایش ردیابی کامل برای خطاهای داخلی.

--ساده مدت
هنگام نمایش نوار پیشرفت سعی نکنید از کنترل رنگ یا مکان نما استفاده کنید.
هشدارها یا خطاها

اقدامات

--html خروجی HTML بنویسید [پیش‌فرض]

--لاتکس خروجی LaTeX را بنویسید.

--dvi خروجی DVI را بنویسید.

--ps خروجی Postscript را بنویسید.

--pdf خروجی Adobe Acrobat (pdf) را بنویسید.

--بررسی بررسی کامل بودن اسناد را انجام دهید.

-- ترشی مستندات را در یک فایل ترشی بنویسید.

نسل OPTIONS

--docformat قالب
مقدار پیش فرض را برای __docformat__ به قالب. __docformat__ یک ماژول است
متغیری که زبان نشانه گذاری را برای رشته های اسناد در یک ماژول مشخص می کند.
مقدار آن شامل نام یک زبان نشانه گذاری است که به صورت اختیاری با a دنبال می شود
کد زبان (مانند en برای انگلیسی). برای لیستی از زبان های نشانه گذاری
در حال حاضر توسط epydoc شناخته شده است، اجرا کنید epydoc --کمک docformat.

--فقط تجزیه
با تجزیه موارد مربوطه، تمام اطلاعات مربوط به اشیاء مستند را جمع آوری کنید
کد منبع پایتون؛ به طور خاص، انجام دهید نه از درون نگری برای جمع آوری استفاده کنید
اطلاعات در مورد اشیاء مستند این گزینه باید زمانی استفاده شود که
epydoc بر روی کدهای نامعتبر اجرا می شود. یا روی کدهایی که قابل بررسی نیستند
به دلیل عدم وابستگی، یا به این دلیل که واردات آن باعث ناخواسته می شود
اثرات جانبی.

--فقط درون نگری
جمع آوری تمام اطلاعات در مورد اشیاء مستند با درون نگری. که در
خاص، انجام دادن نه جمع آوری اطلاعات با تجزیه منبع Python شی
کد

-- استثناء کردن الگو
هیچ شیئی را که نام آن با عبارت منظم داده شده مطابقت دارد مستند نکنید
الگوی.

-- حذف - درون نگری الگو
از درون نگری برای جمع آوری اطلاعات در مورد هر شیئی که نام آن است استفاده نکنید
با عبارت منظم داده شده مطابقت دارد.

--exclude-parse الگو
از تجزیه کد منبع پایتون برای جمع آوری اطلاعات در مورد هر شیء استفاده نکنید
که نام آن با عبارت منظم داده شده مطابقت دارد.

--وراثت قالب
قالبی که باید برای نمایش متدهای ارثی، متغیرها و
خواص در جداول "خلاصه" تولید شده. اگر قالب "گروه بندی" است، سپس
اشیاء ارثی بر اساس کلاسی که هستند در گروه هایی جمع می شوند
به ارث رسیده از. اگر قالب "فهرست شده" است، سپس اشیاء به ارث برده شده در a فهرست می شوند
لیست کوتاه در انتهای جدول خلاصه اگر قالب سپس "شامل" است
اشیاء ارثی با اشیای غیر ارثی مخلوط می شوند. فرمت پیش فرض
برای خروجی HTML "گروه بندی شده است."

--نمایش-خصوصی، -- بدون خصوصی
این گزینه ها کنترل می کنند که آیا مستندات برای اشیاء خصوصی تولید می شوند یا خیر.
به طور پیش فرض، اسناد تولید شده شامل اشیاء خصوصی است و کاربران می توانند
با کلیک بر روی "show private" انتخاب کنید که آیا اشیاء خصوصی مشاهده شود یا خیر.
و پیوندهای خصوصی را پنهان کنید. اما اگر می خواهید مستقیماً کاربران را منصرف کنید
با دسترسی به اشیاء خصوصی، ممکن است ترجیح دهید اسناد تولید نکنید
برای اشیاء خصوصی

--نمایش-واردات، -- بدون واردات
این گزینه ها کنترل می کنند که آیا واردات ماژول در تولید شده گنجانده شده است یا خیر
مستندات. به طور پیش فرض، واردات شامل نمی شود.

--show-sourcecode, --بدون کد منبع
این گزینه‌ها کنترل می‌کنند که epydoc باید با نحو برجسته تولید کند یا خیر
صفحات حاوی کد منبع هر ماژول در خروجی HTML. به صورت پیش فرض،
صفحات کد منبع تولید می شوند.

--شامل-ورود
یک صفحه HTML ایجاد کنید epydoc-log.html حاوی تمام پیام های خطا و هشدار
که توسط epydoc تولید می شوند و آن را در خروجی تولید شده قرار می دهند.

--بدون-شامل-ساخت-زمان
زمان ساخت را در فوتر صفحه چاپ نکنید. این مفید است اگر شما
تلاش برای تولید بیلدهای قابل تکرار، که در آن هر یک در مقابل یک معین ساخته می شود
نسخه درخت منبع دقیقاً همان مصنوعات را تولید می کند.

OUTPUT OPTIONS

-o دیر, -- خروجی دیر
دایرکتوری خروجی اگر دیر وجود ندارد، سپس ایجاد خواهد شد. اگر نه
دایرکتوری خروجی مشخص می شود، سپس نام اقدام (به عنوان مثال، اچ تی ام ال or پی دی اف). اچ تی ام ال

-c ورق, --css ورق
شیوه نامه CSS برای فایل های خروجی HTML. اگر ورق یک فایل، سپس شیوه نامه است
از آن فایل کپی شده است. در غیر این صورت، ورق به نام a گرفته شده است
شیوه نامه داخلی برای فهرستی از شیوه نامه های داخلی، اجرا کنید epydoc --کمک
CSS. اگر یک شیوه نامه CSS مشخص نشده باشد، آنگاه شیوه نامه پیش فرض است
استفاده شده.

-n نام, --نام نام
نام پروژه ای که مستندات آن در حال تولید است.

-u آدرس, -- آدرس اینترنتی آدرس
آدرس صفحه اصلی پروژه.

--navlink اچ تی ام ال
کد HTML برای پیوند صفحه اصلی در نوار پیمایش HTML. اگر این کد HTML
حاوی هر گونه پیوند (<a href=...>، سپس کلمه به کلمه درج می شود. اگر
هیچ پیوندی ندارد و آدرس پروژه مشخص شده است (با
-- آدرس اینترنتی، سپس یک لینک به URL مشخص شده به پیوند اضافه می شود.

---فایل کمک پرونده
یک فایل راهنمای جایگزین پرونده باید شامل بدنه یک فایل HTML باشد --
نوارهای ناوبری به آن اضافه خواهد شد.

-- نمایش قاب ها، --بدون قاب
این گزینه ها کنترل می کنند که آیا خروجی HMTL شامل یک جدول مبتنی بر فریم است یا خیر
صفحه مطالب. به طور پیش فرض، فهرست مطالب مبتنی بر فریم ها گنجانده شده است.

- کلاس های جداگانه
در خروجی LaTeX، هر کلاس را در بخش جداگانه ای از آن توضیح دهید
اسناد و مدارک، به جای اینکه آنها را در اسناد خود لحاظ کنید
ماژول ها این یک فایل LaTeX جداگانه برای هر کلاس ایجاد می کند، بنابراین می تواند باشد
اگر می‌خواهید مستندات یک یا دو کلاس را اضافه کنید مفید است
بخش هایی از سند LaTeX خودتان.

GRAPH OPTIONS

-- نمودار نوع گراف
شامل نمودارهای نوع نوع گراف در خروجی تولید شده نمودارها تولید می شوند
با استفاده از نقطه اجرایی Graphviz. اگر این فایل اجرایی در مسیر نیست، پس
استفاده کنید --dotpath مکان آن را مشخص کند. این گزینه ممکن است تکرار شود تا شامل شود
چندین نوع گراف در خروجی نوع گراف باید یکی از: تمام,
درخت کلاس, کالنگراف، یا umlclasstree.

--dotpath مسیر
مسیر گرافویز نقطه قابل اجرا

---graph-font فونت
نام فونت مورد استفاده برای تولید نمودارهای Graphviz. (به عنوان مثال، هلوتیکا یا
بار).

--graph-font-size اندازه
اندازه فونت مورد استفاده برای تولید نمودارهای Graphviz، در نقاط.

--pstat پرونده
یک فایل خروجی pstat، برای استفاده در تولید نمودار تماس.

برگشت ارزش OPTIONS

-- شکست در خطا
در صورت وجود هر گونه خطا، وضعیت خروج غیر صفر را برگردانید، که نشان دهنده شکست است
مواجه شده.

- اخطار خطا
در صورت وجود هر گونه خطا یا هشدار، وضعیت خروج غیر صفر را برگردانید، که نشان دهنده شکست است
مواجه می شوند (بدون احتساب هشدارهای رشته مستند).

--fail-on-docstring-warning
در صورت وجود هر گونه خطا یا هشدار، وضعیت خروج غیر صفر را برگردانید، که نشان دهنده شکست است
مواجه می شوند (از جمله هشدارهای docstring).

HTML فایل ها

اسناد HTML API تولید شده توسط epydoc شامل فایل های زیر است:

هدف - شی مستندات صفحات

index.html به
نقطه ورودی استاندارد برای اسناد. به طور معمول، index.html به کپی است
از فایل فریم (frames.html). اما اگر --بدون قاب سپس از گزینه استفاده می شود
index.html به یک کپی از صفحه اصلی اسناد API است که معمولاً این صفحه است
صفحه مستندات برای بسته یا ماژول سطح بالا (یا صفحه درختان اگر
هیچ بسته یا ماژول سطح بالا وجود ندارد).

واحد-module.html
اسناد API برای یک ماژول. واحد نام کامل نقطه چین است
ماژول مانند سیستم or epydoc.epytext.

کلاس-class.html
اسناد API برای یک کلاس، استثنا یا نوع. کلاس کامل است
نام نقطه نقطه کلاس، مانند epydoc.epytext.Token or آرایه.ArrayType.

واحد-pysrc.html
یک صفحه برجسته شده با نحو حاوی کد منبع پایتون برای واحد. این
صفحه شامل پیوندهایی به صفحات اسناد API است.

module-tree.html
سلسله مراتب ماژول

class-tree.html
سلسله مراتب طبقاتی این صفحه فقط در صورتی ایجاد می شود که حداقل یک کلاس وجود داشته باشد
ثبت شده.

شاخص ها

identifier-index.html
فهرستی از تمام شناسه های مستند. اگر نمایه شناسه حاوی تعداد بیشتری باشد
بیش از 3,000 ورودی، سپس برای هر حرف به صفحات جداگانه تقسیم می شود.
تحت عنوان identifier-index-a.html, identifier-index-b.html، و غیره

term-index.html
فهرستی از تمام اصطلاحات تعریف شده به صراحت. این صفحه فقط
در صورتی ایجاد می شود که حداقل یک عبارت تعریف در یک رشته مستند فرمت شده علامت گذاری شده باشد.

bug-index.html
فهرستی از همه به صراحت علامت گذاری شده است @حشره زمینه های. این صفحه فقط در صورتی ایجاد می شود که
حداقل یکی @حشره فیلد در یک رشته مستند فرمت شده فهرست شده است.

todo-index.html
فهرستی از همه به صراحت علامت گذاری شده است @انجام دادن زمینه های. این صفحه فقط در صورتی ایجاد می شود که
حداقل یکی @انجام دادن فیلد در یک رشته مستند فرمت شده فهرست شده است.

change-index.html
فهرستی از همه به صراحت علامت گذاری شده است @تغییر کرد زمینه های. این صفحه فقط تولید می شود
اگر حداقل یکی @تغییر کرد فیلد در یک رشته مستند فرمت شده فهرست شده است.

deprecated-index.html
فهرستی از همه به صراحت علامت گذاری شده است @منسوخ زمینه های. این صفحه فقط
اگر حداقل یکی ایجاد شود @منسوخ فیلد در یک رشته مستند فرمت شده فهرست شده است.

since-index.html
فهرستی از همه به صراحت علامت گذاری شده است @از آنجا که زمینه های. این صفحه فقط تولید می شود
اگر حداقل یکی @از آنجا که فیلد در یک رشته مستند فرمت شده فهرست شده است.

بر اساس قاب جدول OF فهرست

frames.html
فایل فریم های اصلی. دو قاب در سمت چپ پنجره شامل یک
فهرست مطالب و قاب اصلی در سمت راست پنجره شامل
صفحات اسناد API

toc.html
صفحه فهرست مطالب سطح بالا. این صفحه در بالا سمت چپ نمایش داده می شود
قاب از frames.html، و پیوندهایی به toc-everything.html و
toc-واحد-module.html صفحات.

toc-everything.html
فهرست مطالب کل پروژه این صفحه در صفحه نمایش داده می شود
قاب پایین سمت چپ از frames.htmlو پیوندهایی را به هر کلاس ارائه می دهد، نوع،
استثنا، تابع و متغیر تعریف شده توسط پروژه.

toc-واحد-module.html
فهرست مطالب یک ماژول. این صفحه در پایین سمت چپ نمایش داده می شود
قاب از frames.htmlو پیوندهایی به هر کلاس، نوع، استثنا ارائه می دهد،
تابع و متغیر تعریف شده توسط ماژول. واحد کامل نقطه چین است
نام ماژول، مانند سیستم or epydoc.epytext.

OTHER صفحات

راهنما. html
صفحه راهنما برای پروژه این صفحه نحوه استفاده و پیمایش را توضیح می دهد
صفحه وب تولید شده توسط epydoc.

redirect.html
این صفحه از جاوا اسکریپت برای ترجمه نام های نقطه چین به موارد مربوطه استفاده می کند
URL ها به عنوان مثال، در مستندات epydoc، بارگذاری صفحه
به طور خودکار تغییر مسیر خواهد داد
مرورگر به .

epydoc.css
شیوه نامه CSS برای نمایش تمام صفحات HTML استفاده می شود.

epydoc.js
یک فایل جاوا اسکریپت که برای تعریف توابع جاوا اسکریپت مورد استفاده توسط epydoc استفاده می شود.

epydoc-log.html
صفحه ای حاوی گزارشی از تمام هشدارها و خطاهایی که توسط آن ایجاد شده است
epydoc، همراه با جدولی که تمام گزینه های استفاده شده را فهرست می کند.

لاتکس فایل ها

مستندات LaTeX API تولید شده توسط epydoc شامل فایل های زیر است:

api.pdf
یک فایل Adobe Acrobat (pdf) حاوی اسناد کامل API. این
فایل تنها در صورتی ایجاد می شود که از آن استفاده کنید --pdf گزینه.

api.tex
فایل LaTeX سطح بالا. این فایل سایر فایل های LaTeX را برای ایجاد یک وارد می کند
سند واحد واحد

api.dvi
یک فایل dvi حاوی مستندات کامل API. این فایل فقط
در صورت استفاده از --dvi گزینه، --ps گزینه ، یا --pdf گزینه.

api.ps یک فایل پست اسکریپت حاوی مستندات کامل API. این فایل فقط
در صورت استفاده از --ps گزینه یا --pdf گزینه.

واحد-module.tex
اسناد API برای یک ماژول. واحد نام کامل نقطه چین است
ماژول مانند سیستم or epydoc.epytext.

کلاس-class.tex
اسناد API برای یک کلاس، استثنا یا نوع. کلاس کامل است
نام نقطه نقطه کلاس، مانند epydoc.epytext.Token یا array.ArrayType.
این فایل های مستندات کلاس فقط در صورتی ایجاد می شوند که - کلاس های جداگانه
گزینه استفاده می شود؛ در غیر این صورت، مستندات هر کلاس در آن گنجانده شده است
فایل مستندات ماژول

عیب یابی

EPYTEXT MARKUP هشدار پیام ها
خطاهای متن متنی توسط رشته‌های اسناد متنی ایجاد می‌شوند که دارای نشانه‌گذاری نامعتبر هستند. هر زمان که
یک خطای متنی شناسایی می شود، رشته مستند مورد نظر به عنوان یک متن ساده در نظر گرفته می شود
رشته مستندسازی Epydoc می تواند خطاهای متنی زیر را ایجاد کند:

بد پیوند هدف.
هدف مشخص شده برای ساخت لینک درون خطی (L{...}) خوب نیست-
شکل گرفت. اهداف پیوند باید شناسه پایتون معتبر باشند.

بد URI هدف.
هدف مشخص شده برای ساخت uri درون خطی (تو{...}) به خوبی شکل نگرفته است.
این معمولاً در صورتی رخ می دهد که نشانه گذاری درون خطی در داخل هدف URI تو در تو باشد.

زمینه باید be at la بالا سطح.
لیست فیلدها (@paramو غیره) توسط ساختار بلوکی دیگری موجود است
(مانند فهرست یا بخش).

زمینه باید be la نهایی عناصر.
لیست فیلدها (@paramو غیره) در انتهای یک رشته مستندسازی نیست.

عنوان باید رخ می دهد at بالا سطح.
عنوان در ساختار بلوک دیگری (مانند یک لیست) قرار دارد.

نادرست دکترا مسدود کردن تورفتگی
بلوک doctest از تورفتگی خط اعلان اولیه خود خارج می شود.

نادرست عنوان تورفتگی
عنوان یک بخش با پاراگراف های موجود در سمت چپ تراز نشده است
بخشی که حاوی آن است.

نادرست بند تورفتگی
پاراگراف های داخل یک بلوک تراز چپ نیستند. این خطا اغلب است
زمانی که رشته‌های اسناد متن ساده با استفاده از متن متنی تجزیه می‌شوند، ایجاد می‌شود.

نامعتبر در رفتن.
یک توالی فرار ناشناخته با ساختار فرار درون خطی استفاده شد
(E{...}).

لیست باید be تورفتگی
یک خط بدون فرورفتگی بلافاصله بعد از یک پاراگراف با یک گلوله لیست شروع می شود.
Epydoc مطمئن نیست که آیا قصد دارید یک آیتم لیست جدید را شروع کنید یا برای یک
پاراگراف شامل کلمه ای که شبیه گلوله است. اگر قصد داشتید
سابق، سپس لیست را تورفتگی کنید. اگر مورد دوم را در نظر داشتید، آن را تغییر دهید
بسته بندی کلمه پاراگراف، یا فرار از اولین کاراکتر کلمه که
شبیه گلوله است

عدم تعادل '{'.
رشته docstring شامل بریس های نامتعادل است. متن متنی به همه پرانتزها نیاز دارد
باید متعادل باشد برای قرار دادن یک بریس منفرد نامتعادل، از escape استفاده کنید
دنباله های E{lb} (پرانتز چپ) و E{rb} (پرانتز راست).

عدم تعادل '}'.
رشته docstring شامل بریس های نامتعادل است. متن متنی به همه پرانتزها نیاز دارد
باید متعادل باشد برای قرار دادن یک بریس منفرد نامتعادل، از escape استفاده کنید
دنباله های E{lb} (پرانتز چپ) و E{rb} (پرانتز راست).

ناشناخته خطی نشانه گذاری برچسب.
یک برچسب ناشناخته با ساخت نشانه گذاری درون خطی استفاده شد ( x{...} ).

اشتباه زیر خط دار خط شخصیت برای عنوان
کاراکتر زیر خطی که برای عنوان این بخش استفاده می شود نشانگر یک نیست
سطح بخش مناسب برای خط کشی باید از کاراکتر "=" استفاده شود
بخش ها "-" برای بخش های فرعی؛ و "~" برای زیربخش ها.

ممکن بد فرمت شده رشته آیتم استفاده کنید.
Epytext خطی را شناسایی کرد که شبیه یک مورد فیلد است، اما درست نیست
قالب بندی شده است. این معمولاً زمانی اتفاق می‌افتد که کولون انتهایی (":") گنجانده نشده باشد
در تگ فیلد

ممکن عنوان غلط املایی
Epytext یک جفت خط را شناسایی کرد که شبیه یک عنوان هستند، اما تعداد آنها
نویسه های زیر خط با تعداد کاراکترهای عنوان مطابقت ندارد.
تعداد کاراکترهای این دو خط باید دقیقاً مطابقت داشته باشد
عنوان در نظر گرفته شده است.

رشته هشدارها
اخطارهای فیلد به دلیل رشته های مستند حاوی فیلدهای نامعتبر ایجاد می شوند. مطالب از
فیلد نامعتبر به طور کلی نادیده گرفته می شود. Epydoc می تواند فیلد زیر را ایجاد کند
هشدارها:

@param برای ناشناخته پارامتر پارامتر.
یک فیلد param@ برای تعیین نوع پارامتری که نیست استفاده شد
در امضای تابع گنجانده شده است. این معمولاً به دلیل یک اشتباه تایپی در ایجاد می شود
نام پارامتر

برچسب انجام داد نه انتظار an بحث و جدل.
تگ فیلد برچسب با استدلال استفاده شد، اما آن را نمی گیرد.

برچسب انتظار می رود an بحث و جدل.
تگ فیلد برچسب بدون استدلال استفاده شد، اما به یکی نیاز دارد.

@نوع برای ناشناخته پارامتر پارامتر.
یک فیلد @type برای تعیین نوع پارامتری که شامل نشده است استفاده شد
در امضای تابع این معمولاً به دلیل یک اشتباه تایپی در ایجاد می شود
نام پارامتر

@نوع برای ناشناخته متغیر VAR.
یک فیلد @type برای تعیین نوع یک متغیر استفاده شده است، اما نه دیگری
اطلاعات در مورد متغیر شناخته شده است. این معمولاً به دلیل یک اشتباه تایپی در ایجاد می شود
نام متغیر

ناشناخته رشته برچسب برچسب.
یک رشته مستند حاوی فیلدی با تگ ناشناخته است برچسب.

تعریف مجدد of رشته.
چندین تگ فیلد مقدار آن را مشخص می کند رشته در همان docstring، اما رشته
فقط می تواند یک مقدار را بگیرد.

مثال ها

epydoc -n epydoc -u http://epydoc.sf.net epydoc/
مستندات HTML API را برای بسته epydoc و تمام موارد آن ایجاد کنید
زیر ماژول ها، و خروجی را در اچ تی ام ال فهرست راهنما. در سرفصل ها و
فوترها، استفاده کنید epydoc به عنوان نام پروژه، و http://epydoc.sf.net به عنوان پروژه
URL.

epydoc --pdf -n epydoc epydoc/
مستندات API LaTeX را برای بسته epydoc و تمام موارد آن ایجاد کنید
زیر ماژول ها، و خروجی را در شیرابه دایرکتوری.

خروج وضعیت

0 اجرای موفقیت آمیز برنامه

1 خطای استفاده

2 Epydoc یک خطا یا هشدار و یکی از گزینه ها ایجاد کرد -- شکست در خطا,
- اخطار خطا, or --fail-on-docstring-warning مشخص شد.

دیگر خطای داخلی (استثنای پایتون).

با استفاده از خدمات onworks.net از epydoc به صورت آنلاین استفاده کنید