چطور کد های خواناتر و قابل فهم تری بنویسیم

حامد محمدیحامد محمدی
161 بازدید
قابل فهم و خوانا کردن کد نویسی نرم افزار

قابل فهم و خوانا بودن کد هایی که می نویسید ممکن است برای شخص دیگری سخت باشد.

این در حالی است که هنگام نوشتن کد برای یک برنامه ، رفع همه اشکالات و کامپایل کردن آن به راحتی امکان پذیر است.

در مقاله امروز وب سایت پرنیان طرح چند نکته وجود دارد که به شما در بهبود بخشیدن به سادگی کد نویسی هایتان کمک می کند.

در ادامه همراه ما باشید.

[cdb_box_content]

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

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

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

از جمله این مقالات ، درباره کد نویسی ابتدایی به زبان ++C بود.

شما می توانید این مقاله را از این لینک مطالعه کنید.

در ادامه مقاله امروز همراه پرنیان باشید.

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

[/cdb_box_content]
[cdb_box_content]

قدم اول

قابل فهم و خوانا کردن کد نویسی نرم افزار

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

آنها ممکن است مهارت های برنامه نویسی ضعیفی داشته باشند .

و یا اطلاعات کمی درباره پروژه داشته باشند.

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

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

[/cdb_box_content]
[cdb_box_content]

قدم دوم

قابل فهم و خوانا کردن کد نویسی نرم افزار

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

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

نه اینکه با زیاد کردن خطوط کد نویسی ، فرد بعدی که قرار است روی ان کار کند را ، تحت تاثیر قرار دهیم.

[/cdb_box_content]
[cdb_box_content]

قدم سوم

قابل فهم و خوانا کردن کد نویسی نرم افزار

معمولا پیگیری و ادامه دادن یک الگوریتم کار دشواری است.

اما معمولا این اتفاق می افتد.

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

اگر URI به مکانی اشاره می کند که دایمی و ثابت نباشد ، اطلاعات را در جایی کپی کنید که نویسنده بعدی کد بتواند آن را پیدا کند.

[/cdb_box_content]
[cdb_box_content]

قدم چهارم

قابل فهم و خوانا کردن کد نویسی نرم افزار

به  استاندارد کدگذاری در هدر فایل مراجعه کنید.

در صورت امکان پرونده ای فراهم کنید تا ابزارها بتوانند تنظیمات صحیح را از آنجا فراخوانی کنند.

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

اما این زبانه ها به طرق مختلف در ویرایشگرهای متنی مختلف ارائه شده است.

استفاده از فضای سفید به جای زبانه ها ممکن است ارجح باشد.

اما داشتن پرونده ای که تنظیمات مناسب را برای یک پروژه فراهم کند بهتر است.

[/cdb_box_content]
[cdb_box_content]

قدم پنجم

قابل فهم و خوانا کردن کد نویسی نرم افزار

از فضای سفید استفاده کنید.

از خطوط بین کد که کارهای متفاوتی انجام می دهند پرش کنید. (نادیده بگیرید)

و از فضاهای بعد از , و ; استفاده کنید.

این کار باعث می شود که کد شما مرتب تر و ساده تر به نظر برسد.

[/cdb_box_content]
[cdb_box_content]

قدم ششم

قابل فهم و خوانا کردن کد نویسی نرم افزار

داخل پرانتزها بنویسید.

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

انجام این کار می تواند هنگام نوشتن یک کد طولانی کمک کند.

قرار دادن اعلان ها و حلقه های شرط های if باعث می شود خواندن و درک برنامه شما آسان باشد.

این تکنیک را لانه سازی می نامند ،

این روش نشان می دهد که یک تکه کد در یک تکه کد دیگر “لانه سازی شده” است و به خواننده اجازه می دهد تا به راحتی الگوی لانه سازی را دنبال کند.

به این کار تکنیک if های تو در تو نیز می شود.

[/cdb_box_content]
[cdb_box_content]

قدم هفتم

قابل فهم و خوانا کردن کد نویسی نرم افزارکامنت های توصیفی بنویسید.

فرض کنید شخصی که کد شما را می خواند چیزی از آنچه که قرار است این کد انجام دهد نمی داند.

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

همه الگوریتم های پیشرفته ، گیج کننده یا پیچیده شما باید کاملاً کامنت نویسی شده باشند.

همچنین ، سعی کنید توصیف کنید که کد چیست؟

به عنوان مثال ، به جای نوشتن “اضافه شدن به  متغیر” ، بنویسید که چرا این متغیر ؛در کد اهمیت دارد .

زیرا هر کسی می تواند ببیند که مقدار در حال افزایش متغیر است ، به عنوان مثال “افزایش تعداد بازدیدهای صفحه با شمارش ۱قدم “.

[/cdb_box_content]
[cdb_box_content]

قدم هشتم

قابل فهم و خوانا کردن کد نویسی نرم افزار

کدهای خود را با ایجاد نامهای توصیفی که توضیح می دهد اهداف آنها چیست ، “مستند سازی” و قابل فهم تر کنید.

اشیاء و ابجکت های موجود در کد باید اشاره به دامنه مشکل اشاره کنند.

یک لیست ، لیست است.

ممکن است مجبور شوید یک لیست مشتری ایجاد کنید که زیر کلاس ها یا یک لیست را پیاده سازی کند.

متغیرها  و پارامترهای توابع باید دارای اسامی توصیفی باشند.

[/cdb_box_content]
[cdb_box_content]

قدم نهم

قابل فهم و خوانا کردن کد نویسی نرم افزار

در توضیحات اولیه پرونده ، نویسنده اصلی کد ها و نگه دارنده فعلی کد را درج کنید.

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

[/cdb_box_content]
[cdb_box_content]

قدم دهم

قابل فهم و خوانا کردن کد نویسی نرم افزار

اغلب ، کامنت گذاری کنید.

کامنت  بنویسید تا هدف خود را بیان کنید.

وجود کامنت های بیشتر درباره کد شما ، منجر به حذف برداشت های شخصی و اشتباه از کد شما خواهد شد.

 

منبع : وب سایت wikihow

[/cdb_box_content]
دسته بندی مقاله ها
اشتراک گذاری
راه حل صحیح موفقیت این است که اشتیاق شما به پیروزی بیشتر از ترس شما از شکست باشد.”انیشتین“

نوشته های مرتبط

دیدگاهتان را بنویسید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *

21+ محصولات
374+ سفارشات تکمیل شده
1860+ کاربران
396+ مطالب وبلاگ
سبد خرید

هیچ محصولی در سبد خرید نیست.

ورود به سایت