مستندسازی یکی از مهمترین مراحل برنامه نویسی است که مانند تست، کمی در حاشیه قرار گرفته است. وقتی بعد از ۶ ماه دوباره به کدهای خود سر می زنید، مستندسازی مناسب احساس خوبی به شما می دهد، و بالعکس آن هم وجود دارد. در پروژه های بزرگ و تیمی که مستندسازی یک امر لازم و غیر قابل اجتناب است. پس بهتر است به آن عادت کرده و آن را جدی بگیریم. در این نوشته ابزار مستندسازی در برنامه نویسی php را معرفی می کنیم. ما برای یک مستندسازی خوب، چند معیار داریم که عبارتند از:
- استاندارد مشخص
- تولید اتوماتیک خروجی مناسب(pdf، chm، xml و …)
- چهارچوب مشخص ورود اطلاعات
- پشتیبانی در IDE های مختلف
حال به معرفی ابزار میپردازیم.
۱۶- phpDocumentor :
phpDocumentor که با نامهای phpdoc و phpdocu نیز شناخته می شود. ابزاری جهت مستندسازی کدهای php است. یکی از قابلیتهای آن، تولید خروجی های pdf، html، chm و xml DocBook است. تقریباً شبیه به JavaDoc برای زبان برنامه نویسی Java است. یکی از امتیازات آن پشتیبانی در اکثر IDE های مختص زبان php و همچنین استفاده در پروژه های مهمی همچون zend framework، sugar crm و … است. نصب آن نیز خیلی ساده است که میتوانید در این آدرس آنرا بیابید.
۱۷- ApiGen :
یک ابزار جدی که ویژگی های جالبی دارد. طبق معرفی انجام شده در وبسایت ApiGen، ابزاری جهت ساخت مستنداتی حرفه ای برای سورسهای php که شباهت زیادی به phpDocumentor دارد. یکی از مزیت های آن پشتیبانی از php 5.3 و ایجاد لینک بین مستندات و کلاسها و توابع و پکیج های کدهای منبع php است. از دیگر ویژگیهای آن موارد زیر قابل ارائه است.
- مستندات دقیق از کلاس ها، توابع و ثابت ها
- برجسته سازی کد منبع
- پشتیبانی فضاهای نامی، پکیج ها و زیر پکیج ها
- ایجاد ساختار درختی از کلاس ها، واسط، صفات و استثناها
- لینک دانلود مستندات به صورت فایل zip
- و …
۱۸- Doxygen :
Doxygen نیز یک مستندساز اتوماتیک است، که کارهای گفته شده را انجام می دهد. این ابزار جهت استفاده در زبان C++ بوجود آمد؛ ولی برای استفاده در زبانهای دیگر نیز کارایی دارد (زبانهایی همچون php، C#، پایتون و …). این ابزار ابتدا برای مک و لینوکس آماده شده بود، ولی هم اکنون قابلیت استفاده در ویندوز را هم دارد.
موارد معرفی شده در وبسایت smashing فقط دو ابزار phpDocumentor و PHPDOX بود، که PHPDOX دیگر پشتیبانی نمی شود. بنابراین من دو مورد دیگر را جایگزین آن کرده ام. اگر از این ابزار استفاده کرده و نظری در مورد آنها دارید خوشحال میشوم در دیدگاه ها اعلام نمایید.
نظرات کاربران
نظر خود را بفرستید:
آدرس ایمیل شما منتشر نخواهد شد.