آشنایی با phpdoc

وقتی در یک تیم قرار دارید که کارشان کدنویسی، برنامه نویسی یا توسعه است (همانطور که در متن توسعه تفاوت آنها را بیان کردیم) . این تیم میتواند تیمی در یک شرکت بزرگ یا تیمی در محیطی کوچکتر باشد.

زمانی که می‌خواهیم کدها را برای افراد تیم بفرستیم ممکن است با دیدن کدهای ماگیج شوند و یا در تجزیه و تحلیل آن با مشکل روبه رو شوند. یکی از بهترین راه ها مستندسازی است که استفاده phpdoc  راحت تر وبهتراست.برای آشنایی با phpdoc به ادامه مطلب بروید.

PHPDOC

یک ابزار قدرتمند برای مستند سازی است که با استفاده از آن میتوان برنامه کد ها را به درستی   و آسانی تجزیه و تحایل کرد. PHPDOC به صورت الگویی خاص است که بهتراست با آنها آشنا شوید.

IDE های قدرتمند مانندphpstorm و مخصوصا zendstdio  از آن پشتیبانی می‌کنند.

تفاوت مستندسازی به صورت معمولی و با استفاده ازphpdoc  

1) مستند سازی معمولی با /// شروع شده ویا ( با/* شروع شده و با */تمام می شوند) به صورت زیر:

 برای تک خطی ها مناسب است //

/*  در آن  می توان از یک خط تاnخط نوشت  */

و مستندسازی با استفاده از phpdoc به صورت زیر است:

*/  در آن میتوان از یک خط تاnخط با الگو نوشت /** 

2) در مستندسازی با phpdoc توضیحات نوشته شدهدر آن برای ide ها قابل فهم است به عنوان مثال اگر روی متغیر (ctrl+کلیک) کنیم. توضیحات مربوط به متغیربرای ما نمایش داده میشود ولی در مستندسازی معمولی چنین نیست.

3) در بعضی ide ها گزینه هایی برای ساخت مستند phpdoc و جود دارد به این صورت که اگر روی خط یا متغیر یا کلاس و... کلیک کنیم گزینه ای برای ساختphpdoc وجود دارد و اگر روی آن کلیک کنید قالب آن تشکیل میشود وتنها کافی است بعضی از قسمت های آن را ویرایش کرده و یا توضیحاتی را اضافه کنید.

برای آشنایی با تگ های phpdoc مطلب بعدی ما را درhttp://mahdieharghavani.blog.ir/1398/11/08/%D8%AA%DA%AF-%D9%87%D8%A7%DB%8C-phpdoc بخوانید