اهمیت کامنت گذاری در کد ها

قبلا نوشته ای در مورد یک سری نکات که باید برنامه نویس ها رعایت کنند در بلاگ منتشر کردیم و اونجا بر روی کامنت گذاری در کد هامون تاکیید زیادی کردیم ، حالا در این نوشته قراره بیشتر در مورد کامنت گذاری و جزییات اون صحبت کنیم .

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

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

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

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