از کامنت های بی اثر بپرهیزید

این تاپیک 0 پاسخ و 1 مشارکت کننده دارد . آخرین آپدیت توسط :  صبا ...saba ،‏ 7 ماه و 3 هفته پیش .

این تاپیک تاکنون 98 بازدید داشته است .

نویسنده پست
جمعه ، 15 آوریل 2016     1:53 ق.ظ #


صبا ...saba

Subscriber
0 پست669 تاپیک

اجازه بدهید با کامنت بی اثر شروع کنیم. بر طبق نظر Robert C. Martin

کامنتی که کهنه، نامرتبط و نادرست باشد کامنت بی اثر است. کامنت ها با سرعت زیادی کهنه می شوند. بهتر است کامنتی که کهنه و بی اثر می شود ننویسیم. بهتر است هر چه سریعتر کامنت بی اثر را ویرایش کنیم و یا از شر آن راحت شویم. کامنت های بی اثر و کهنه جزیره هایی شناور از مسائل منحرف کننده و نامرتبط با کد می شوند.

جملاتی که در ادامه می آید موضوعی است که نقل صحبت برنامه نویس ها در مورد کامنت است. از نوشتن کامنت روی یک متد منحصر به فرد یا کلاس کوتاه بپرهیزید. به این دلیل که اکثر کامنت هایی که بنده تا کنون دیده ام در صدد بوده اند تا هدف کد را توصیف کنند. برخی از اوقات کامنت ها بی معنا هستند. برنامه نویس ها کامنت می نویسند تا خوانایی و معناداری کد را افزایش دهند. مطمئن شوید که کامنت های شما باعث ایجاد نویز نشود. بهتر است به جای اینکه کامنت بنویسید نام متد را در صورت امکان با معنا تر بنویسید، به این دلیل توصیه می کنم که نام متد موثرتر از کامنت است. اکثر کامنت ها چیزی جز نویز بی معنا نیستند. اجازه دهید کامنت های زیر را بررسی کنیم.

 

اگر به جای نوشتن کامنت برای یک متد، آن را مانند  ()CancelExportForDeletedProducts نامگذاری کنیم، چه اتفاقی می افتد؟ بنابراین، نام متد موثر تر از کامنت است. متدها اجرا می شوند و واقعی هستند.

این برداشت به وجود نیاید که بنده تاکید دارم که پرهیز از کامنت در تمام اوقات یک باید است. بر طبق نظر کنت، کامنت را به صورت کلی برای توصیف این که کل داستان چه کاری انجام می دهد بگذارید نه این که روی تک تک متدها و حتی خطهای کد. اگر کامنت در صدد بود همه چیز را توصیف کند آنگاه اشتباه است. اگر شما با کدی که حجم زیادی کامنت دارد مواجه شدید، بدین معناست که اکثر کامنت ها در کد حاضر شده اند چون کد، کد خوبی نیست. برای اطلاعات بیشتر در این مورد می توانید کتابهای زیر را مطالعه فرمایید:

Professional Refactoring in C# and ASP.NET by Danijel Arsenovski
"Refactoring: Improving the Design of Existing Code" by Martin FowlerKent BeckJohn BrantWilliam Opdykedon Roberts

0  تشکر
پست 1 تا 1 (از مجموع 1 پست)

برای پاسخ دادن به این تاپیک باید وارد سایت شوید .