بالابردن خوانایی کد

بالا بردن خوانایی کد

ابتدا کد را برای اشخاص بنویسید، بعد برای کامپیوتر...!

مدت زمانی که برای نوشتن کدهای خوانا صرف می کنید بیشتر از زمانی که صرف نوشتن کدهای گیج کننده می کنید، نیست. (حداقل در مدت زمانی طولانی که کدها اجرا می شود)

وقتی شما کدتان را خوانا نوشتید، اطمینان از این که کد درست کار می کند بیشتر است.

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

کد، وقتی که شخص دیگری می خواهد قسمتی از کد شما را در پروژه مشابه دیگری استفاده کند نیز خوانده می شود. 

"حالا اگر کد را فقط برای خودتان بنویسید چطور؟ چرا باید کدتان را خوانا کنید؟"

خوب، مهمترین دلیلی که برای نوشتن کد خوانا وجود دارد این است که، یک هفته نهایتا دو هفته بعد از الان که شما کد را نوشتید، سراغ پروژه دیگری می روید.

چه اتفاقی می افتد اگر شخص دیگری قصد داشت تا خطایی را روی پروژه شما برطرف کند؟

با اطمینان می توانم بگویم که خود شما هم در کد وحشتناکی که نوشتید سر در گم می شوید.

از نظر من یک کد خوب باید ویژگی های زیر را داشته باشد:

• کدی که آسان نوشته شود، آسان تغییر پیدا کند، و  آسان توسعه پیدا کند.
• کدی که تمیز و مرتب است و حرف می زند و معنا را می رساند.
• کدی که ارزش دارد و از کیفیت خوبی برخوردار است.

بنابراین، کدی بنویسید که بجای این که نیاز ماشین را تا درجه ای از ضرورت برآورده کند توسط بشر قابل خواندن باشد.

چگونه می توان خوانایی کد را بهبود داد؟

ابتدا باید شما کدهای دیگران را بخوانید و در مورد نکات خوب و بد آن کد به جمع بندی برسید.

چه چیزی باعث شد تا شما کد را بهتر متوجه شوید و کدام مورد منجر به این شد که شما احساس کنید فهم کد پیچیده است.

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

استانداردسازی در یک شرکت نرم افزاری کاری سخت و دشوار است، اما باید از روشهایی از قبیل آموزش، مرور کد دو نفره، و استفاده از ابزارهای مرور کد خودکار و .. این کار را انجام داد.

معروفترین ابزارهایی که برای خواندن کد و خوانا کردن آن وجود دارد در زیر آمده است:

• FxCop: ابزاری است برای تجزیه و تحلیل کدهای NET. این ابزار صدها قانون را برای انواع تجزیه و تحلیل به کار می گیرد.
• StyleCop: پروژه ای است کدباز که کدهای سی شارپ را تحلیل می کند تا یک سری استایل و قوانین پایداری را به کد اعمال کند. این پروژه هم از داخل ویژوال استودیو اجرا می شود و هم می تواند با پروژه ی MSBuild یکپارچه شود. StyleCop همچنین با خیلی دیگر از ابزارها یکپارچه شده است
• JetBrains ReSharper: یک ابزار بسیار مشهور است که ویژوال استودیوی مایکروسافت را یک IDE بهتری می کند. هزاران برنامه نویس NET. در سرتاسر دنیا در شک و تحیر فرورفته اند که چگونه آنها تا کنون بدون بازرسی کد Resharper زنده بوده اند و زندگی می کردند. چرا تا کنون از بازسازی کد خودکار آن بی نصیب مانده اند، از چرخش راحت در کدها و کمک رسانی به کدزنی این ابزار بهره ای نبرده اند.

• قبلی
• بعدی