نوشتن کد باکیفیت هنری است که هر برنامه نویسی آرزوی تسلط بر آن را دارد. در این مسیر، ما ۱۱ نکته همراه با نمونه های جاوا ارائه می دهیم تا به شما در نوشتن کد بهتر، تمیزتر و کارآمدتر کمک کند.
۱. اول مشکل را بفهمید
قبل از شروع به کد نویسی، درک مشکلی که در حال حل آن هستید، ضروری است. بیایید فرض کنیم که ما باید حداکثر عدد را در یک آرایه پیدا کنیم. درک مشکل ما را به یک راه حل ساده هدایت می کند:
// اعداد را در یک آرایه ذخیره کنید
int[] numbers = {1, 3, 5, 7, 9};
// حداکثر عدد را پیدا کنید
int max = Arrays.stream(numbers).max().getAsInt();
// حداکثر عدد را چاپ کنید
System.out.println("Max number is: " + max);
۲. کد خود را برنامه ریزی کنید
برنامه ریزی کد شما را از سردردهای آینده نجات می دهد. برای مثال، اگر در حال ایجاد کلاسی برای نمایش یک Person
هستیم، می توانیم ویژگی ها و متدهایی را که این کلاس باید داشته باشد، برنامه ریزی کنیم.
// کلاس Person را تعریف کنید
class Person {
// نام و سن را به عنوان فیلدهای کلاس تعریف کنید
String name;
int age;
// سازنده کلاس را با دو پارامتر name و age تعریف کنید
Person(String name, int age) {
// مقادیر پارامترها را به فیلدهای مربوطه اختصاص دهید
this.name = name;
this.age = age;
}
// متد sayHello را تعریف کنید
void sayHello() {
// نام شخص را با استفاده از System.out.println چاپ کنید
System.out.println("Hello, my name is " + name);
}
}
// نمونه ای از کلاس Person ایجاد کنید
Person person1 = new Person("Ali", 25);
// متد sayHello را برای نمونه person1 فراخوانی کنید
person1.sayHello();
۳. آن را ساده نگه دارید
سادگی در کد نویسی کلیدی است. از پیچیدگی های غیر ضروری اجتناب کنید. به عنوان مثال، در صورت امکان از متدهای داخلی جاوا استفاده کنید.
// آرایه ای از رشته ها با نام words ایجاد کنید
String[] words = {"apple", "banana", "cherry"};
// بررسی کنید که آیا "banana" در آرایه words وجود دارد یا خیر
boolean contains = Arrays.asList(words).contains("banana");
// نتیجه را چاپ کنید
System.out.println("Does the array contain 'banana'? " + contains);
۴. از نام های معنادار استفاده کنید
نام های توصیفی باعث می شود کد شما راحت تر قابل درک باشد. مثال زیر را در نظر بگیرید:
// نامگذاری نامناسب
int a = 5;
int b = 10;
// نامگذاری مناسب
int تعدادسیب = ۵;
int تعدادپرتقال = ۱۰;
۵. عاقلانه نظر دهید
از نظرات برای توضیح «چرا» استفاده کنید، نه «چی»:
// این یک نظر نامناسب است
int x = 5; // 5 را به x اختصاص می دهد
// این یک نظر مناسب است
int x = 5; // از ۵ شروع کنید زیرا ۵ مقدار اول از قبل پردازش شده اند
۶. از یک استاندارد کدنویسی پیروی کنید
سازگاری کد شما را برای خواندن آسان تر می کند. به عنوان مثال، همیشه از camelCase برای نام متغیرها و متدها استفاده کنید:
// قبل از بازسازی
for (String word : words) {
System.out.println(word);
}
// بعد از بازسازی
Arrays.stream(words).forEach(System.out::println);
۷. به طور منظم Refactor کنید
Refactoring منظم کد شما را بهبود می بخشد. برای مثال، میتوانید حلقهها را با API جریان جاوا ۸ جایگزین کنید تا کدهای خواناتری داشته باشید:
// قبل از بازسازی
for (String word : words) {
System.out.println(word);
}
// بعد از بازسازی
Arrays.stream(words).forEach(System.out::println);
۸. کد خود را تست کنید
آزمایش تضمین می کند که کد شما همانطور که انتظار می رود کار می کند. در اینجا یک تست ساده JUnit آورده شده است:
@Test
public void testMaxNumber() {
// آرایه ای از اعداد را تعریف کنید
int[] numbers = {1, 3, 5, 7, 9};
// با استفاده از Stream API حداکثر عدد را پیدا کنید
int max = Arrays.stream(numbers).max().getAsInt();
// با استفاده از assertEquals بررسی کنید که حداکثر عدد ۹ باشد
assertEquals(9, max);
}
۹. از دیگران بیاموزید
خواندن کد دیگران شما را در معرض سبک ها و تکنیک های مختلف قرار می دهد. به عنوان مثال، پروژه های منبع باز جاوا را در GitHub بررسی کنید.
۱۰. به یادگیری ادامه دهید
با آخرین فن آوری ها و بهترین شیوه ها به روز باشید. به عنوان مثال، اگر شما یک توسعه دهنده جاوا هستید، در مورد ویژگی های جدید در آخرین نسخه جاوا بیاموزید.
۱۱. استراحت کنید
کدنویسی می تواند از نظر ذهنی خسته کننده باشد. استراحت های منظم می تواند به شما در حفظ سطح بهره وری بالا و جلوگیری از فرسودگی کمک کند.