مستندسازی

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

وبلاگ

کد خود را به خوبی کامنت‌گذاری کنید

بسیاری از توسعه دهندگان PHP کامنت‌هایی را برای کدهایشان می‌نویسند، اما این زبان خودش هیچ قوانینی برای اینکه چگونه اینکار را انجام دهید ندارد. بنابراین دقیقا چه چیزی را باید در بلاک‌های کامنت بنویسید تا آنها کاربردی و سودمند باشند؟ چه بخش‌هایی از کد باید مستندسازی شود و چه بخش‌های نباید؟ در ادامه به برخی نکات مهم برای نامگذاری صحیح، مشخص کردن محدوده دسترسی و Type hinting پرداخته شده که رعایت آن‌ها به شما در قابل فهم شدن و مستندسازی بهتر کدهای PHP تان کمک خواهد کرد.

مجتبی پاکزاد مجتبی پاکزاد
2 سال پیش

راهنمای مستندسازی با phpdoc

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

مجتبی پاکزاد مجتبی پاکزاد
2 سال پیش