کامنت گذاری برای کدنویسی بهتر

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

چرا کامنت گذاری کنیم ؟

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

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

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

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

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

پس اگر تا الان این موضوع رو جدی نمی گرفتین بیاین کمی در موردش فکر کنید ...