توثيق Go Code مع Godoc

مدونة او مذكرة

كما تعلم ، إذا قرأت مدونتي ، فقد كنت أقوم ببناء مجموعة من حزم الأدوات المساعدة الجديدة حتى أتمكن من البدء في تطوير خادم تطبيق أحتاجه لمشروع جديد. أنا جديد على Go و Mac OS. لا داعي للقول إنه كان جحيمًا للتعليم خلال الشهر الماضي. لكني لا أفتقد Windows أو C ## على الإطلاق.



لقد أحرزت بعض التقدم في الترميز وأردت إنشاء وثائق للرمز. كنت أستخدم عارض التوثيق في LiteIDE وكنت آمل أن أدمج وثائقي هناك بشكل جيد. لقد فوجئت حقًا برؤية أن LiteIDE قد أدرجت حزمي بالفعل داخل عارض Godoc المدمج. لذلك تساءلت بعد ذلك عن السؤال. كيف يتم ذلك؟






بعد بعض البحث وجدت ملف HTML المحلي هذا. إذا كان لديك LiteIDE مثبتًا ، فيمكنك نسخ عنوان url التالي في متصفحك.



ملف: ///Applications/LiteIDE.app/Contents/Resources/golangdoc/about.html



هذا ما يظهر






ملخص

يوفر عارض Godoc المدمج في LiteIDE طريقة سهلة لتصفح الوثائق التي تم إنشاؤها بواسطة أداة godoc دون مغادرة المحرر. يمكن الاطلاع على الوثائق لكل من لغة Go الرسمية وكذلك الحزم المخصصة. يصف الجزء المتبقي من هذه الصفحة طرقًا لاستدعاء عارض Godoc.

أنظمة URL المعتمدة

من الممكن عرض الوثائق عن طريق إدخال عنوان URL مباشرة في شريط عنوان عارض Godoc. عند القيام بذلك ، يمكنك تحديد نوع الوثائق التي تبحث عنها عن طريق إضافة العنوان بأحد أنظمة URL التالية:

تجد

يبحث عن الحزم ذات السلسلة المحددة في أسمائها. على سبيل المثال:

  • تجد: الرمز البريدي
  • تجد: godoc

قائمة

يسرد كل الحزم في دليل معين. الخيارات الرئيسية هي pkg و cmd ، والتي يمكن العثور عليها كروابط في رأس الصفحة. على سبيل المثال:

  • list: pkg - تعرض حزم Golang
  • list: cmd - تعرض أوامر Golang

pdoc

يعرض وثائق لحزمة أو أمر محدد. على سبيل المثال:

  • pdoc: fmt
  • pdoc: أرشيف / مضغوط
  • pdoc: gofmt
  • pdoc: f: / hg / zmq / gozmq

ملف

يعرض ملف HTML محدد أو Markdown أو نص عادي. على سبيل المثال:

  • الملف: c: /go/doc/docs.html

المخططات التلقائية

بالنسبة لأنظمة الملف و pdoc ، لا تحتاج إلى كتابة المخطط كجزء من عنوان URL. على سبيل المثال:

  • /doc/code.html
  • / src / pkg
  • / src / cmd
  • / pkg / fmt
  • / cmd / cgo
  • أرشيف / مضغوط
  • يذهب

متصفح الملفات

يمكنك فتح عارض Godoc مباشرة من متصفح الملفات عن طريق النقر بزر الماوس الأيمن على ملف أو دليل واختيار عرض Godoc هنا. سيفتح عارض Godoc تلقائيًا وثائق الحزمة للعنصر المختار.

#يذهب

www.ardanlabs.com

توثيق Go Code مع Godoc

كما تعلم ، إذا قرأت مدونتي ، فقد كنت أقوم ببناء مجموعة من حزم الأدوات المساعدة الجديدة حتى أتمكن من البدء في تطوير خادم تطبيق أحتاجه لمشروع جديد. أنا جديد على Go و Mac OS. لا داعي للقول إنه كان جحيمًا للتعليم خلال الشهر الماضي. لكني لا أفتقد Windows أو C # على الإطلاق.