راهنمای داکیومنت نویسی برای توسعه دهندگان

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

معرفی افزونه DocBlockr #

افزونه داک بلاکر برای اتم
با استفاده از افزونه Docblockr در کد ادیتورهای Atom, Sublime , VSCode به آسانی می‌توانید از قابلیت های داکیومنت اتوماتیک این افزونه استفاده کنید. این افزونه برای تسریع و ساده سازی داکیومنت نویسی ساخته شده و از زبان PHP کاملا پشتیبانی می‌کند.

نصب افزونه #

نصب DocBlockr در Atom #

برای نصب این این افزونه پس از نصب کد ادیتور Atom از طریق CMD ویندوز یا ترمینال مک یا لینوکس خود از دستور زیر استفاده کنید.  
apm install docblockr

پس از چند ثانیه افزونه شما نصب شده و آماده استفاده در کد ادیتور است. همچنین برای نصب این افزونه می‌توانید از صفحه این افزونه در بخش پکیج های Atom استفاده کنید. پس از کلیک بر روی دکمه Install کد ادیتور شما اجرا شده و اقدام به نصب افزونه می‌‎کند.  

نصب DocBlockr در VSCode #

برای نصب این افزونه پس از ورود به بخش Extenstions در کد ادیتور یا فشردن کلید های Ctrl + Shift + X و سرچ کردن PHP DocBlocker اقدام به نصب افزونه کنید. همچنین می‌توانید با استفاده از صفحه این افزونه در بخش مارکت VSCode اقدام به نصب این افزونه نمایید. پس از کلیک بر روی دکمه Install کد ادیتور شما اجرا شده و اقدام به نصب افزونه می‌‎کند.  

نصب DocBlockr در Sublime #

پکیج کنترلر را از مسیر Preferences -> Package Control در تنظیمات باز کنید. Package Control: Install Package را انتخاب کرده و DocBlocker را جستجو کرده و اقدام به نصب آن نمایید. در کد ادیتور سابلایم همچنین می‌توانید از افزونه PHPDoc نیز استفاده کنید که کاربرد مشابهی دارد.

نحوه استفاده #

کامنت نویسی #

برای نوشتن کامنت های چند خطی در کد خود پس از زدن /** کلید Enter یا Tab را فشار دهید و افزونه اقدام به ساخت یک بلاک کامنت در کد شما می‌کند. 

نحوه استفاده

داکیومنت کردن فانکشن ها #

جهت داکیومنت کردن فانکشن های نوشته شده در کد در خط قبل تعریف فانکنشن پس از نوشتن /** با فشردن کلید Enter یا Tab افزونه اقدام به شناسایی نام و مقادیر فانکشن و نوشتن اتوماتیک داکیومنت ها می‌کند. پس از آن کافیست توضیحات فانکشن و پارامتر ها را اضافه کنید. 

داکیومنت کردن متغیر ها #

در خط قبل از تعریف متغیر خود با وارد کردن /** و سپس فشردن کلید Tab یا Shift + Enter افزونه اقدام به شناسایی تایپ متغیر و نوشتن اتوماتیک داکیومنت می‌‎کند. تنها لازم است توضیحات متغیر را وارد کنید. 

دیگر توضیحات #

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

لینک های مفید #

قدرت گرفته از BetterDocs

دیدگاهتان را بنویسید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *