0

clean code در فلاتر flutter

در توسعه نرم افزار ، کد پاک تمیز و یا همون clean code بسیار  مهم است. نوشتن یک کد  تمیز ، قابل درک و قابل نگهداری برای هر توسعه دهنده نرم افزاری مهارت مهمی است. ناامیدکننده است که کد دیگران را ادامه دهید اما نمی توانید بفهمید چه کاری انجام می دهد. در این مقاله ، من برخی از نکات خود را آورده ام تا کد شما برای دیگران کمی تمیزتر و آسان تر باشد.

نامهای معنی دار برای متغیر ها

اگر متغیر خود را به درستی نامگذاری کنید ، نیازی به نوشتن کامنت برای آن  ندارید. از حروف مانند x ، y ، z برای یک متغیر استفاده نکنید (برای متغیرهای حلقه یک استثنا است).

// نام گذاری نادرست
int x = 1; // period number
int c = 0; // counter
// نام گذاری صحیح
int periodNumber = 1;
int counter = 0;

درصورت نیاز به قرار دادن یک تابع به عنوان آرگومان ، نیازی به متغیر تابع نیست ، از _ به عنوان نام متغیر استفاده کنید.

نوشتن کامنت در صورت نیاز

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

// کامنت ها با دو اسلش مشخص میشوند
/// مستندات و داکیومنت ها با سه اسلش مشخص میشوند

شما می توانید در یک الگوریتم پیچیده نظرات خود را بنویسید ، اما در مورد هر کلاس یا متدی اینگونه نیست. این مثال من برای اسناد در یک کلاس abstract است:

 

توابع خود را کوتاه کنید

توابع فقط باید یک کار یا یک مسئولیت انجام دهند. اگر از این قانون پیروی کنید عملکرد شما کم خواهد بود. برای کاهش نسخه برداری ، توابع را از کد خود استخراج کنید.می‌توانید مانند مثال پایین عمل کنید:

این کد ها را به چیزی شبیه به کد های پایین تبدیل کنیم

 

 

ساختار پروژه

برای آسان تر یافتن فایل ها  در کد منبع خود ، باید ساختار پروژه خود را تعریف کنید که همه باید بدانند. برای کد Flutter ، پرونده های منبع باید حروف کوچک باشد. در داخل پروژه ما README.md حاوی ساختار پروژه است.

 

فایل README.md

 

 

قرارداد های زبان خود را بدانید

فلاتر از زبان دارت استفاده میکند, اگر نمیدانید از چه نام برای کلاس ها و یا متغیر های خود استفاده کنید به Effective Dart: Style بروید.این سایت شامل بهترین روش ها برای نام فال ها با جزییات ان ها هست.

 

https://dart.dev/guides/language/effective-dart/style

 

اگر می خواهید  clean code بیشتر بدانید ، توصیه می کنم این کتاب را بخوانید:

ممنون که مقاله من را خوندین و وقتتون رو گذاشتین. امیدوارم نظرتون رو جلب کرده باشه 🙂

ارسال دیدگاه

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