PHPDoc، قسمت اول - معرفی

هر برنامه نویسی که در سطح مبتدی برنامه نویسی می کنه وقتی یه واژه جدید بگوشش می خوره شاخکاش تیز می شه تا با افزایش دانش خودش سطح برنامه نویسیش رو ارتقاع بده... "مستند سازی" هم می تونه یک واژه جدید باشه. با یک جستجوی کوچیک می شه یه چیزایی راجع به مستند سازی متوجه شد. اما این دانش ابتدایی سوالاتی رو در ذهن ایجاد می کنه که پاسخ به اون سوالات می تونه به پیشرفت در این دانش جدید کمک کنه!
 مستند سازی :
"مستند سازی برنامه" یا "مستند سازی کد منبع" یک متن نوشتاری همراه با نرم افزار رایانه ایی است. بطور کلی این متن نحوه استفاده یا چگونگی عملکرد را شرح می دهد.
مستند سازی بخش مهمی از مهندسی نرم افزار است. انواع اسناد برابر است با:
1- موارد نیاز: شامل بیانیه هایی از شناسایی ویژگی ها ، امکانات ، ویژگی ها و کیفیت سیستم است. این شالوده ای است برای آنچه باید پیاده سازی شود.
2- معماری/طراحی : پیش نمایشی از نرم افزار. شامل روابط با محیط و اصول ساخت و ساز تا در طراحی اجزای نرم افزار استفاده شود.
3- فنی : مستندات از کد، الگوریتم، interfaces و API ها.
4- محصول نهایی : دفترچه راهنما برای کاربر نهایی، مدیران سیستم و کارکنان پشتیبانی.
5- بازاریابی : چگونگی عرضه محصول و تجزیه و تحلیل تقاضای بازار.
PHPDoc در رده شماره 3 یعنی مستند سازی فنی قرار می گیرد که در داخل کد پیاده می شود.
PHPDoc :
PHPDoc یک اقتباس از JavaDoc است. این اقتباس در واقع توافق استاندار برای توضیحات نویسی ( commenting ) برای زبان برنامه نویسی PHP است.
وجود این استاندارد باعث می شود تا مستند ساز های خارجی ( document generators ) مانند PHPDocumentor بتواند برای API ها مستند سازی کنند و به IDE هایی مانند Zend Studio، NetBeans، ActiveState Komodo Edit and IDE و Aptana Studio  برای تفسیر انواع متغییر و ابهامات دیگر در زبان های نوع آزاد ( loosely typed language ) کمک می کند.
PHPDoc از هر دو نوع کدنویسی روالی و شی گرا برا مستند سازی پشتیبانی می کند.
فک کنم تا اینجا برای معرفی کافی باشه... :D