PDA

View Full Version : متدهای تکراری و کامنت نویسی برای اونها با PHPDoc



code.zan
شنبه 15 فروردین 1394, 15:25 عصر
توی پروژه ها پیش میاد که مثلا 10 تا کنترلر داریم حالا هر 10 تاشون هم متد های CRUD رو دارند.
ماهیت کار تو همشون یکی هست. یعنی create تو فرم دسته بندی؛ باعث ایجاد یک دسته بندی جدید میشه و به همین صورت متد create تو کنترلر محصول باعث ایجاد یک محصول جدید میشه.
خب حالا سوال اینه که اگه من بخوام یک پروژه تر تمیز و استاندارد با کامنت نویسی PHPDoc داشته باشم. باید برای هر متد بصورت جداگانه بیام کامنت بنویسم؟ :متفکر:
خب اگر هم این کار رو کنم که خیلی از کامنت ها تکراری میشه و تو همین مثالی که بالا زدم برای متد create باید 10 تا کامنت تقریبا یکسان کپی کنم!
نمی دونم تونستم منظورم رو برسونم !؟!

MMSHFE
سه شنبه 18 فروردین 1394, 10:01 صبح
بله باید برای همه، جداگانه بنویسید. مسئله اینه که توی یک پروژه دیگه ممکنه یک کنترلر رو لازم باشه کپی کنید یا مستنداتی که با PHPDoc تولید شده رو بخواین بین اعضای تیم توزیع کنید تا مطالعه کنن. اینجا دیگه نمیتونین به افراد بگین برو توضیحاتش رو از فلانی بگیر!