وردپرس مجموعه ای از قوانین و پیشنهادات برای کدنویسی استاندارد را فراهم کرده است .

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

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

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

https://codex.wordpress.org/WordPress_Coding_Standards

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

مستندسازی کدهای افزونه وردپرس

یکی از مهمترین کارهایی که در اغلب موارد نادیده گرفته می شود ، مستندسازی ، ایجاد توضیحات یا کامنت گذاری کدهاست .

مستندسازی کدهای افزونه ، یک روش سریع و ساده برای نمایش نحوه عملکرد افزونه می باشد .

مستندسازی کدها دارای مزایای بسیاری است که در این بخش به چند مورد از آنها می پردازیم .

مزیت اصلی مستندسازی ، تشریح کار واقعی هر بخش از کدهای شماست .

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

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

مستندسازی برای همه سودمند است ، بنابراین همیشه کدهای خود را مستند کنید و توضیحات کافی به آنها اضافه کنید .

تقریباً همه توابع موجود در هسته وردپرس دارای مستندات توکار در قالب PHPDoc هستند .

PHPDoc یک روش استاندارد برای توضیح عملکرد یک تابع در قالب توضیحات php می باشد .

در مثال زیر مستندسازی یک تابع توسط PHPDoc را مشاهده می کنید :

همانطور که می بینید ، توضیحات PHPDoc به خوبی عملکرد تابع ، پارامترهای ورودی و نوع برگشتی آن را تشریح می کنند .

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

این نوع مستندسازی در نرم افزارهایی مانند PHPDocumentor و PHPXref نیز مورد استفاده قرار می گیرد .

حذف افزونه وردپرس توسط قلاب Uninstallنامگذاری متغیرها ، توابع و فایل ها در افزونه وردپرس
پیشنهاد می کنیم برای دریافت آخرین مطالب کانال تلگرام کانی تمزرا دنبال کنید .