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

برنامه:

نام

godoc - استخراج و تولید اسناد برای برنامه های Go

خلاصه

godoc [پرچم] فرمان [ نام ... ]

شرح

گودوک برای برنامه های Go مستندات را استخراج و تولید می کند.

دو حالت دارد.

بدون پرچم -http، در حالت خط فرمان اجرا می شود و اسناد متنی ساده را چاپ می کند
به خروجی و خروجی استاندارد. اگر هم یک بسته کتابخانه و هم دستوری با نام یکسان باشد
وجود دارد، استفاده از پیشوند cmd/ به جای دستور، مستندات را بر روی فرمان تحمیل می کند
بسته کتابخانه اگر پرچم -src مشخص شده باشد، godoc رابط صادراتی a را چاپ می کند
بسته در فرم منبع Go، یا اجرای یک موجودیت زبان صادر شده خاص:

سند godoc fmt # برای بسته fmt
godoc fmt Printf # مستندات برای fmt.Printf
godoc cmd/go # document force برای دستور go
رابط بسته godoc -src fmt # fmt در فرم منبع Go
godoc -src fmt Printf # پیاده سازی fmt.Printf

در حالت خط فرمان، پرچم -q پرس و جوهای جستجو را در برابر یک godoc فعال می کند که به صورت a اجرا می شود
وب سرور اگر هیچ آدرس سرور صریحی با پرچم سرور - مشخص نشده است، ابتدا godoc
localhost:6060 را امتحان می کند و سپس http://golang.org.

godoc -q Reader
godoc -q ریاضی.سین
godoc -server=:6060 -q sin

با پرچم -http، به عنوان یک وب سرور اجرا می شود و اسناد را به عنوان یک صفحه وب ارائه می دهد.

godoc -http=:6060

به طور پیش‌فرض، godoc به بسته‌هایی که از طریق $GOROOT و $GOPATH (در صورت تنظیم) پیدا می‌کند، نگاه می‌کند.
دایرکتوری های اضافی ممکن است از طریق پرچم -path که لیستی از دو نقطه را می پذیرد مشخص شود.
مسیرهای جدا شده؛ مسیرهای بدون ریشه نسبت به دایرکتوری کاری فعلی هستند. هر مسیر
به ترتیب ظاهر به عنوان روت اضافی برای بسته ها در نظر گرفته می شود. آخرین
عنصر مسیر (مطلق) پیشوند مسیر بسته است. به عنوان مثال، با توجه به پرچم
مقدار:

path=".:/home/bar:/public"

برای یک godoc که در /home/user/godoc شروع شده است، مسیرهای مطلق به مسیرهای بسته نگاشت می شوند.
به شرح زیر است:

/home/user/godoc/x -> godoc/x
/home/bar/x -> bar/x
/public/x -> public/x

هنگامی که godoc به عنوان یک وب سرور اجرا می شود و -index تنظیم می شود، یک فهرست جستجو حفظ می شود. شاخص
در هنگام راه اندازی ایجاد می شود.

فهرست شامل شناسه و اطلاعات جستجوی متن کامل (قابل جستجو از طریق
عبارات با قاعده). حداکثر تعداد نتایج جستجوی متن کامل نشان داده شده را می توان با تنظیم کرد
پرچم -maxresults; اگر روی 0 تنظیم شود، هیچ نتیجه متن کاملی نشان داده نمی شود و فقط یک شناسه نمایش داده می شود
فهرست اما هیچ نمایه جستجوی متن کامل ایجاد نمی شود.

حالت ارائه صفحات وب ارائه شده توسط godoc را می توان با URL "m" کنترل کرد
پارامتر؛ لیستی از نام های پرچم جدا شده با کاما را به عنوان مقدار می پذیرد:

تمام نشان دادن اسناد برای همه اظهارنامه ها، نه فقط موارد صادر شده

روش
همه روش‌های تعبیه‌شده را نشان می‌دهد، نه فقط روش‌های فیلدهای ناشناس صادر نشده

" کد منبع اصلی را به جای مستندات استخراج شده نشان دهید

متن صفحه را به صورت متنی (خط فرمان) به جای HTML ارائه دهید

صاف فهرست های دایرکتوری مسطح (نه تورفتگی) را با استفاده از مسیرهای کامل ارائه دهید

به عنوان مثال، http://golang.org/pkg/math/big/?m=all، متن اسناد را برای همه نشان می دهد
(نه فقط صادر شده) اعلامیه های بسته بزرگ، به شکل متنی (همانطور که به نظر می رسد
هنگام استفاده از godoc از خط فرمان: "godoc -src math/big .*").

به‌طور پیش‌فرض، godoc فایل‌هایی را از سیستم فایل سیستم‌عامل زیربنایی ارائه می‌کند. در عوض، یک .zip
فایل ممکن است از طریق پرچم -zip، که شامل سیستم فایل برای خدمت است، ارائه شود. پرونده
مسیرهای ذخیره شده در فایل zip. باید از اسلش ('/') به عنوان جداکننده مسیر استفاده کنند. و آنها باید باشند
بدون ریشه $GOROOT (یا -goroot) باید روی مسیر دایرکتوری فایل .zip حاوی فایل تنظیم شود
به دایرکتوری روت بروید. به عنوان مثال، برای یک فایل zip. ایجاد شده توسط دستور:

zip go.zip $HOME/go

ممکن است godoc را به صورت زیر اجرا کنید:

godoc -http=:6060 -zip=go.zip -goroot=$HOME/go

برای نحوه نوشتن نظرات خوب برای godoc به "Godoc: مستندسازی کد Go" مراجعه کنید:
http://golang.org/doc/articles/godoc_documenting_go_code.html

OPTIONS

-v حالت پرحرف

-q آرگومان ها عبارت های جستجو در نظر گرفته می شوند: یک پرس و جو قانونی یک شناسه واحد است (مانند
به عنوان ToLower) یا یک شناسه واجد شرایط (مانند math.Sin).

-src منبع چاپ (صادرات) در حالت خط فرمان

-tabwidth=4
عرض زبانه ها در واحد فضاها

-timestamps=true
نشان دادن مُهرهای زمانی با فهرست‌های دایرکتوری

-فهرست مطالب شناسه و فهرست جستجوی متن کامل را فعال کنید (اگر -index باشد هیچ جعبه جستجو نشان داده نمی شود
تنظیم نشده)

-index_files=""
الگوی glob مشخص کننده فایل های فهرست. اگر خالی نباشد، نمایه از اینها خوانده می شود
فایل ها به ترتیب مرتب شده اند

-index_throttle=0.75
مقدار دریچه گاز شاخص; مقدار 0 به این معنی است که هیچ زمانی به نمایه ساز اختصاص داده نمی شود (the
نمایه ساز هرگز تمام نمی شود)، مقدار 1.0 به این معنی است که ایجاد فهرست در حال اجرا است
دریچه گاز کامل (سایر گوروتین ها ممکن است در حین ساخت ایندکس زمان نبرند)

-write_index=false
نوشتن فهرست در یک فایل؛ نام فایل باید با -index_files مشخص شود

-maxresults=10000
حداکثر تعداد نتایج جستجوی متن کامل نشان داده شده است (در صورتی که نمایه متن کامل ساخته نشده باشد
حداکثر نتایج <= 0)

-path=""
دایرکتوری های بسته اضافی (جدا شده با دو نقطه)

-html HTML را در حالت خط فرمان چاپ کنید

-goroot=$GOROOT
به دایرکتوری روت بروید

-http=addr
آدرس سرویس HTTP (به عنوان مثال، "127.0.0.1:6060" یا فقط ":6060")

-server=addr
آدرس وب سرور برای جستجوهای خط فرمان

-templates=""
دایرکتوری حاوی فایل های الگوی جایگزین. در صورت تنظیم، فهرست ممکن است ارائه دهد
فایل های الگوی جایگزین برای فایل های $GOROOT/lib/godoc

-url= مسیر
داده هایی را که توسط یک درخواست HTTP برای مسیر ارائه می شود در خروجی استاندارد چاپ کنید

-zip=""
فایل فشرده ارائه فایل سیستم برای خدمت. در صورت خالی بودن غیرفعال می شود

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