حسام حداد تکنولوژی، برنامه‌نویسی، هوش مصنوعی

مقدمه

پیش از این راجع به Bad Smell و کاربرد آن در مهندسی نرم افزار صحبت کردیم "توضیحات یا همان Comment" یکی از 22 نوع Bad Smell میباشد.

نحوه تشخیص و معرفی راه حل Comment
نگران نباشید ما قرار نیست راجع به این که نباید توضیحات بنویسید صحبت کنیم توضیحات در حس بویایی ما بوی بدی نیست. در عوض آنها بوی خوب هستند. به خاطر این توضیحات را مطرح کردیم که معمولا از آنها برای بردن بوی بد استفاده میشود این شگفت انگیز است که شما با نگاه کردن به یک تکه کد با توضیحات بسیار به این نتیجه میرسید که به علت بد بودن کد توضیحات قرار داده شده است.

توضیحات مارا به کد بدی منتهی میکند که میتواند تمامی بو های بد قبلی را داشته باشد در اولین حرکت ما بایست بوی بد را با refactor از بین ببریم سپس وقتی اینکار تمام شد معمولا به نقطه ای میرسیم که توضیحات بی فایده میشوند.

اگر شما نیاز دارید یک توضیح برای تشریح هدف یک تکه کد بنویسید. روش استخراج متد را استفاده کند اگر متد وجود دارد اما باز نیاز به توضیح دارد روش نامگذاری دوباره متد[1] را امتحان کنید. اگر نیاز دارید قوانینی برای سیستم تعریف کنید از معرفی تاکید[2] استفاده کنید.

[1] Rename Method
[2] Introduce Assertion