Blog

Code Readability, Naming Conventions, Refactoring Java In Hindi

Code readability concept in Java.

जावा प्रोग्रामिंग लैंग्वेज में, कोड रीडेबिलिटी कांसेप्ट का अर्थ है, एक ऐसा जावा प्रोग्राम सोर्स कोड क्रिएट डेवलप करना, जिसे कोई भी साधारण अन्य जावा सॉफ्टवेयर डेवलपर आसानी से एनालाइज और अंडरस्टैंड कर सके।

Difficult to read code readability concept.

int m;

double n  = p * r * t;

if (n > 9999) {

m = 9;

}

यहाँ ऊपर दिए गए प्रोग्राम में यह क्लियर डिक्लेअर डिफाइन नहीं है कि यूजर डिक्लेअर प्रोग्राम वेरिएबल में m, p, r, t, और n डाटा टाइप एलिमेंट क्या रिप्रेजेंट करते हैं।

Easy code readability concept.

double intrstAmount = principal * rate * time;

if (intrstAmount > 9000) {

discountAmount = 9;

}

अब यहाँ ऊपर दिए गए प्रोग्राम में डिक्लेअर हर प्रोग्राम डाटा टाइप वेरिएबल एलिमेंट का पर्पस और यूज़ ज़्यादा क्लियर डिफाइन है।

Ways to improve readability in Java source code.

• हर प्रोग्राम में प्रोग्राम के अनुसार रिलेटेड नामों वाले डाटा टाइप एलिमेंट का यूज़ करें।
• हमेशा प्रोग्राम में डिक्लेअर डाटा टाइप मेथड को स्माल रखें।
• अननेसेसरी डीपली प्रोग्राम लूप एक्सप्रेशन नेस्टेड कंडीशन लॉजिक को अवॉयड करे।
• हमेशा मौजूदा प्रोग्राम में कंसिस्टेंट फ़ॉर्मेटिंग का यूज़ करें।
• गैर-ज़रूरी प्रोग्राम में हर कंडीशन एक्सप्रेशन में मैन्युअल कमेंट्स को अवॉयड करे।
• ज्यादातर एक जैसा प्रोग्राम सोर्स कोडिंग स्टाइल फॉर्मेट को फ़ॉलो कांसेप्ट को अवॉयड करे।

The main idea of ​​the code readability concept.

जावा प्रोग्रामिंग लैंग्वेज में, कोड रीडेबिलिटी कांसेप्ट प्रोग्राम सोर्स कोड को इजी ह्यूमन रीडेबल फॉर्मेट में डिज़ाइन और डेवलप किया जाना चाहिए, न कि सिर्फ़ कंप्यूटर के एक्सेक्यूशन आउटपुट के लिए।

Naming convention concept in Java.

जावा प्रोग्रामिंग लैंग्वेज में, नेमिंग कन्वेंशन क्लास, मेथड, वेरिएबल, कॉन्स्टेंट आदि के नाम रखने के रूल्स एंड रेगुलेशन हैं, जिसमे जावा डेवलपर एक प्रोग्राम सोर्स कोड को क्रिएट करते समय नेमिंग कन्वेंशन मेथड को फॉलो करे। जहा हर जावा क्रिएट प्रोग्राम सोर्स कोड से रिलेटेड सभी नेमिंग कन्वेंशन कांसेप्ट को प्रॉपर यूज़ करे.

For the Java Naming convention concept.

Classes → CompanyCase

class EmployeeJob {

}

class PaymentMethod {

}

Methods → employeeCase

void TotalSalary() {

}

void methodPayment() {

}

Variables → employeeCase

String employeeName;

int employeeAge;

double salary;

Constants → UPPER_TEST_CASE

static final int MAX_TEST_COUNT = 7;

static final double PI = 3.14;

Bad naming concept in Java.

int t;

String w;

void y() {

}

Good naming concept in Java.

int employee_Salary;

String client_Name;

void methodPayment() {

}

Boolean naming concept in Java.

जावा प्रोग्राम में डिक्लेअर बूलियन डाटा टाइप वैरिएबल सामान्य रूप से एक सवाल की तरह लगने चाहिए।

boolean isActive;

boolean isAllowed;

boolean isRestricted;

Use this in Java user Boolean naming concept instead.

boolean state;

boolean validity;

The main idea of ​​a naming convention.

एक कस्टम जावा प्रोग्राम सोर्स कोड में एक अच्छा नाम जावा यूजर डेवलपर को यह इंडीकेट करना चाहिए कि मौजूदा प्रोग्राम में कोई प्रोग्राम क्लास, मेथड, वेरिएबल, कॉन्स्टेंट डाटा टाइप में क्या रिप्रजेंटेशन है, या वह मौजूदा प्रोग्राम में क्या करती है।

Refactoring concept in Java.

जावा प्रोग्रामिंग लैंग्वेज में, प्रोग्राम सोर्स कोड रिफैक्टरिंग कांसेप्ट का अर्थ है की मौजूदा प्रोग्राम कोड के एक्सटर्नल बिहेवियर को मॉडिफाई किये बिना उसके इंटरनल स्ट्रक्चर को अपनी मौजूदा प्रोग्राम जरूरत के अनुसार कस्टमाइज या इम्प्रूव करना।

Refactoring concept in simple terms.

वही मौजूदा सोर्स कोड फंक्शनैलिटी + इसके साथ बेहतर प्रोग्राम सोर्स कोड इंटरनल स्ट्रक्चर बिहेवियर

Java program before refactoring concept.

class ItemOrder {

void supplyOrder() {

// Here we calculate the total of the ItemOrder value.

double totalorder = price * quantity;

// Here we apply the required ItemOrder discount method

if (totalorderl > 5000) {

totalorder = totalorder – (totalorder * 0.30);

}

// Here this will print the invoice billing information in the ItemOrder

System.out.println(“The Total Order Is -: ” + totalorder);

}

}

यहाँ इस एक्साम्प्ल में यह तरीका रिफैक्टरिंग कांसेप्ट मेथड पर कई काम कर रहा है।

Java program after refactoring concept.

class ItemOrder {

void supplyOrder() {

double totalorder = countTotal();

totalorder = provideDiscount(totalorder);

printInvoice(totalorder);

}

double countTotal() {

return price * quantity;

}

double provideDiscount(double totalorder) {

if (totalorderl >5000) {

return totalorder – (totalorder * 0.30);

}

return totalorder;

}

void printInvoice(double totalorder) {

System.out.println(“The Total Order Is -: ” + totalorder);

}

}

यहाँ रिफैक्टरिंग कांसेप्ट के बाद मौजूदा प्रोग्राम में इंटरनल बिहेवियर अभी भी वही है, लेकिन मौजूदा प्रोग्राम के सोर्स कोड को एनालाइज अंडरस्टैंड और मेंटेन करना इजी हो जाता है।

Common Java refactoring techniques.

Method Extract Java.

इसमें जावा यूजर प्रोग्राम कोड का एक बड़ा हिस्सा लें और उसे एक अलग मेथड में डालें।

// First source code

void execution() {

// 10 lines of task source code

// 28 lines of job method

}

↓

void execution() {

task();

job();

}

Rename existing program variables.

int p;

↓

int employee_Total;

Remove duplicate program source code.

calculateIncomeTax();

storeWithDatabase();

calculateIncomeTax();

storeWithDatabase();

यहाँ इस प्रोग्राम में एक कॉमन फंक्शनैलिटी को एक मेथड में निकालें।

Replace a magic number in the existing program.

if (emp_age >= 21) {

Improved source code.

final int MINIMUM_EMPLOYEE_AGE = 21;

if (emp_age >= MINIMUM_EMPLOYEE_AGE) {

Main Difference Between Code Readability, Naming Conventions, Refactoring

Conclusion of Code Readability, Naming Conventions, Refactoring.

• Code Readability → क्या मैं और एक सामान्य जावा यूजर किसी प्रोग्राम सोर्स कोड को समझ सकता है?
• Naming Conventions → क्या मौजूदा प्रोग्राम में डिक्लेअर डिफाइन नेमिंग कन्वेंशन क्लास, मेथड, वेरिएबल, कॉन्स्टेंट आदि के नाम को इंडीकेट करते हैं कि ये चीजें मौजूदा प्रोग्राम में क्या टास्क एक्शन को परफॉर्म करती हैं?
• Refactoring → क्या मैं और अन्य जावा यूजर प्रोग्राम सोर्स कोड को बिना मॉडिफाई किये इम्प्रूव कर सकते है?