با phpdoc چطوری مستند سازی پروژه رو انجام بدم

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

PhpDoc ابزار قدرتمند مستندسازی

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

 

PhpDoc چیست؟

PhpDoc اقتباسی از JavaDoc برای زبان برنامه نویسی php است. این ابزار هنوز یک استاندارد غیررسمی برای کامنت‌گذاری کدهای PHP است، اما در هنگام نگارش این مطلب، در حال طی فرآیند رسمی شدن است. phpDoc هم از کدهای شی‌گرا و هم رویه‌گرا پشتیبانی می‌کند. phpdoc ابزاری قدرتمند است که به شما اجازه می‌دهد که به آسانی کدهای خود را در کامنت‌هایی با الگوی خاص مستندسازی نمایید. این مستندات علاوه بر اینکه در سورس کدهای شما در دسترس است در مستندات حرفه‌ای استخراج شده با استفاده از رابط وب و خط فرمان نیز در دسترس هستند. نتیجه می‌تواند در فرمت‌های مختلفی از جمله pdf، html و chm تولید شود. به علاوه، بسیاری از IDEها مانند Zend Studio و PHP Storm قابلیت تکمیل کد را دارند که می‌توانند کامنت‌های phpdoc را تجزیه و تحلیل نموده و ویژگی‌های مفیدی مانند type-hinting را فراهم می‌کند.

نویسنده
پوریا سبحانلو

سلام من پوریا هستم

چند سالی هست تو وب فعال هستم و برنامه نویسی میکنم

اوایل با php کار میکردم بعد ها سریع به پلتفرم های جاوا اسکریپت علاقه مند شدم و الان در حال یادگیری React هستم

سایر مطالب