godoc - على الإنترنت في السحابة

برنامج:

اسم

godoc - يستخرج ويولد التوثيق لبرامج Go

موجز

جودوك [علم] أمر [ الاسم ]

الوصف

يقوم Godoc باستخراج وثائق برامج Go وإنشاءها.

لها وضعان.

بدون علامة -http ، يتم تشغيله في وضع سطر الأوامر ويطبع وثائق النص العادي
لمعيار الإخراج والمخارج. إذا كانت كل من حزمة مكتبة وأمر يحملان الاسم نفسه
موجود ، باستخدام البادئة cmd / سيفرض التوثيق على الأمر بدلاً من ملف
حزمة المكتبة. إذا تم تحديد علامة -src ، فإن godoc يطبع الواجهة المصدرة لـ a
الحزمة في نموذج Go source ، أو تنفيذ كيان لغة مُصدرة محددة:

وثائق godoc fmt # لحزمة fmt
godoc fmt Printf # التوثيق لطباعة fmt.
godoc cmd / go # force التوثيق لأمر go
واجهة حزمة godoc -src fmt # fmt في نموذج Go المصدر
godoc -src fmt Printf # تنفيذ fmt.Printf

في وضع سطر الأوامر ، تتيح العلامة -q استعلامات البحث ضد godoc الذي يعمل كملف
قاعدة بيانات للانترنت. إذا لم يتم تحديد عنوان خادم صريح بعلامة -server ، فإن godoc أولاً
يحاول المضيف المحلي: 6060 ثم http://golang.org.

قارئ godoc -q
godoc -q الرياضيات
خادم godoc =: 6060 -q الخطيئة

باستخدام علامة -http ، يتم تشغيله كخادم ويب ويقدم الوثائق كصفحة ويب.

Godoc -http =: 6060

بشكل افتراضي ، ينظر godoc إلى الحزم التي يعثر عليها عبر $ GOROOT و $ GOPATH (إذا تم تعيينه).
يمكن تحديد أدلة إضافية عبر علامة المسار -التي تقبل قائمة النقطتين-
مسارات منفصلة المسارات غير المروتة هي نسبة إلى دليل العمل الحالي. كل مسار
يعتبر جذرًا إضافيًا للحزم من حيث المظهر. الاخير
عنصر المسار (المطلق) هو البادئة لمسار الحزمة. على سبيل المثال ، بالنظر إلى العلم
القيمة:

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"
معامل؛ يقبل قائمة مفصولة بفواصل بأسماء العلم كقيمة:

الكل إظهار الوثائق لجميع التصريحات ، وليس فقط المصدرة

طرق
إظهار جميع الطرق المضمنة ، وليس فقط تلك الخاصة بالحقول المجهولة غير المصدرة

SRC إظهار كود المصدر الأصلي بدلاً من الوثائق المستخرجة

نص قدم الصفحة في شكل نصي (سطر أوامر) بدلاً من HTML

مسطحة قوائم الدليل الحالية المسطحة (غير المزودة بمسافة بادئة) باستخدام المسارات الكاملة

على سبيل المثال، http://golang.org/pkg/math/big/؟ م = الكل ، يظهر النص التوثيق للجميع
(وليس فقط التصريحات المصدرة) لحزمة كبيرة ، في شكل نصي (كما سيظهر
عند استخدام godoc من سطر الأوامر: "godoc -src math / big. *").

بشكل افتراضي ، يقدم godoc الملفات من نظام الملفات لنظام التشغيل الأساسي. بدلا من ذلك ، ملف مضغوط
يمكن توفير الملف عبر علامة -zip ، التي تحتوي على نظام الملفات المطلوب تقديمه. الملف
يجب أن تستخدم المسارات المخزنة في ملف .zip الشرطة المائلة ('/') كفاصل مسار ؛ ويجب أن يكونوا كذلك
غير متجذر. يجب تعيين $ GOROOT (or -goroot) على مسار دليل ملف .zip الذي يحتوي على الامتداد
اذهب الدليل الجذر. على سبيل المثال ، لملف .zip تم إنشاؤه بواسطة الأمر:

zip go.zip $ HOME / go

يمكن للمرء تشغيل godoc على النحو التالي:

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

راجع "Godoc: توثيق كود Go" لمعرفة كيفية كتابة تعليقات جيدة لـ godoc:
http://golang.org/doc/articles/godoc_documenting_go_code.html

OPTIONS

-v وضع مفصل

-q تعتبر الوسيطات استعلامات بحث: الاستعلام القانوني هو معرف واحد (مثل
كـ ToLower) أو معرف مؤهل (مثل math.Sin).

-src طباعة (تصدير) المصدر في وضع سطر الأوامر

-العرض = 4
عرض علامات التبويب بوحدات المساحات

- الطوابع الزمنية = صحيح
إظهار الطوابع الزمنية مع قوائم الدليل

-فهرس تمكين المعرف وفهرس البحث عن النص الكامل (لا يظهر مربع بحث إذا كان الفهرس هو
غير مضبوط)

-index_files = ""
نمط glob يحدد ملفات الفهرس ؛ إذا لم يكن فارغًا ، فسيتم قراءة الفهرس من هذه
الملفات بالترتيب الفرز

-index_throttle = 0.75
قيمة مؤشر الخانق تعني القيمة 0 عدم تخصيص وقت للمفهرس (ملف
المفهرس لن ينتهي أبدًا) ، تعني القيمة 1.0 أن إنشاء الفهرس يعمل عند
دواسة الوقود الكاملة (قد لا تحصل goroutines الأخرى على وقت أثناء إنشاء الفهرس)

-write_index = false
كتابة فهرس إلى ملف ؛ يجب تحديد اسم الملف باستخدام -index_files

-النتائج القصوى = 10000
يظهر الحد الأقصى لعدد نتائج البحث عن النص الكامل (لا يتم إنشاء فهرس نص كامل إذا
maxresults <= 0)

-المسار = ""
أدلة الحزم الإضافية (مفصولة بنقطتين)

-لغة البرمجة طباعة HTML في وضع سطر الأوامر

-غوروت = $ GOROOT
اذهب الدليل الجذر

-http = العنوان
عنوان خدمة HTTP (على سبيل المثال ، "127.0.0.1:6060" أو فقط ": 6060")

-الخادم = العنوان
عنوان خادم الويب لعمليات البحث في سطر الأوامر

-قوالب = ""
دليل يحتوي على ملفات قوالب بديلة ؛ إذا تم تعيينه ، فقد يوفر الدليل
ملفات القوالب البديلة للملفات الموجودة في $ GOROOT / lib / godoc

-url = المسار
طباعة للإخراج القياسي للبيانات التي سيتم تقديمها بواسطة طلب HTTP للمسار

-zip = ""
ملف مضغوط يوفر نظام الملفات للخدمة ؛ معطلة إذا كانت فارغة

استخدم Godoc عبر الإنترنت باستخدام خدمات onworks.net