karakar
1 سال پیش توسط karakar مطرح شد
4 پاسخ

داکیومنت نویسی

سلام
دوستان کسی هست توضیح بده داکیومنت نویسی برای پروژه های طراحی سایت با لاراول چی هست؟
و چطور باید نوشته بشه.
ممنونم.


ثبت پرسش جدید
علی بیات
تخصص : توسعه دهنده ارشد وب
@ali.bayat 1 سال پیش مطرح شد
1

به نظرم بهترین مستندات پروژه، داشتن فیچر تست هایی هست که همه کارآیی های سیستم رو پوشش بده و با سناریو درست نوشته شده باشه..
اگر هم وب سرویسی دارید در پروژه، استفاده از swagger گزینه خوبی هست.

@karyabi1395
در حالت کلی اگه از اسم های معنی دار برای متغیر ها، پراپرتی ها، متد ها و کلاس ها استفاده کنی... دیگه نیازی به استفاده از کامنت نیست.
اگر هم بلوک های طولانی از کد داری که بدون کامنت خوانا نیستند، این یکی از نشونه های رعایت نکردن اصول کلین کد هست..

@alekasirabolfazl
تنها اثری که داره، اینه که مفسر باید بایت های بیشتری رو بخونه.
اما در سرعت اجرا تاثیری نداره چونکه این خطوط توسط مفسر ایگنور میشه


ابوالفضل
تخصص : برنامه نويس
@amata 1 سال پیش مطرح شد
1

ببین معمولا ما .net Developer ها میگیم باید سه تا پوشه باشه سر پروژه
Src
Test
Doc
از اسمشون هم مشخصه که چیکار میکنن
شما باید یه داکیومنت کلی داشته باشی
واسه اینکه کار سرویس ها و .... رو توش توضیح بدی
یه داکیومنت هم باید inline باشه
با کامنت گذاری وسط کدا هی توضیحات اد کنی توش


karakar
تخصص : برنامه نویس
@karyabi1395 1 سال پیش مطرح شد
0

@joojooo
ممنونم از پاسختون. خیلیها یگن ازکامنت زیاد در بین کدها استفاده نکن چون سرعت تفسیر در لاراول رو کند میکنه. درسته این موضوع؟


ابوالفضل
تخصص : برنامه نويس
@amata 1 سال پیش مطرح شد
0

@karyabi1395
نمیدونم واقعا!
ولی الان که بهش فکر کردم شاید چون مفسریه واقعا درست باشه!
@ali.bayat
آقای بیات همچین چیزی درسته؟


علی بیات
تخصص : توسعه دهنده ارشد وب
@ali.bayat 1 سال پیش مطرح شد
1

به نظرم بهترین مستندات پروژه، داشتن فیچر تست هایی هست که همه کارآیی های سیستم رو پوشش بده و با سناریو درست نوشته شده باشه..
اگر هم وب سرویسی دارید در پروژه، استفاده از swagger گزینه خوبی هست.

@karyabi1395
در حالت کلی اگه از اسم های معنی دار برای متغیر ها، پراپرتی ها، متد ها و کلاس ها استفاده کنی... دیگه نیازی به استفاده از کامنت نیست.
اگر هم بلوک های طولانی از کد داری که بدون کامنت خوانا نیستند، این یکی از نشونه های رعایت نکردن اصول کلین کد هست..

@alekasirabolfazl
تنها اثری که داره، اینه که مفسر باید بایت های بیشتری رو بخونه.
اما در سرعت اجرا تاثیری نداره چونکه این خطوط توسط مفسر ایگنور میشه


برای ارسال پاسخ لازم است وارد شده یا ثبت‌نام کنید

ورود یا ثبت‌نام