Java Programming Style जावा प्रोग्रामिंग की शैली

Programming style is a set of guidelines applied to use the instructions of a programming language correctly. Following a programming style is crucial because it helps the programmer understand the code easily, and it reduces the chances of errors. Here are some important rules for Java programming style-

प्रोग्रामिंग शैली, किसी प्रोग्रामिंग लैंग्वेज के निर्देशों को सही तरीके से उपयोग करने के लिए, लागु किये गए दिशानिर्देशों का एक समूह होता है। एक प्रोग्रामिंग शैली का पालन करना अत्यंत आवश्यक होता है क्योंकि इसकी सहायता से प्रोग्रामर, प्रोग्रामिंग कोड को आसानी से समझ सकता है एवं कम त्रुटियां उत्पन्न होती है। जावा प्रोग्रामिंग शैली के कुछ महत्वपूर्ण नियम निम्न है –

1. A Java program should be easy to read and understand by others, including users or specialist programmers.

एक जावा प्रोग्राम पढने एवं समझने में आसान होना चाहिए। अर्थात हमारे लिखे जावा प्रोग्राम को अन्य उपयोगकर्ता या विशेषज्ञ प्रोग्रामर के समझ में आने योग्य होना चाहिए।

2. Each class (excluding nested classes) should have Javadoc comments and an `@author` tag indicating the purpose of the class, all general interfaces, and the name of the programmer.

प्रत्येक क्लास (नेस्टेड कक्षाओं को छोड़कर) में जावाडॉक टिप्पणी एवं एक @author टैग होना चाहिए जो क्लास के उद्देश्य, सभी जनरल इंटरफ़ेस एवं प्रोग्रामर के नाम को दर्शाते हो।

3. Each method (excluding private methods) should have Javadoc comments explaining its purpose

प्रत्येक मेथड (प्राइवेट मेथड को छोड़कर) में जावाडॉक टिप्पणी होनी चाहिए जो बताती है कि यह क्या करती है।

4. Each variable should have a comment explaining its purpose.

प्रत्येक वेरिएबल में एक टिप्पणी होनी चाहिए जो उसके उद्देश्य की व्याख्या करे।

5. A method's body can include comments that explain the logic of the written code.

एक मेथड की बॉडी में, टिपण्णी को शामिल किया जा सकता है जो लिखे गए कोड के लॉजिक की व्याख्या कर सके।

6. Use indentation to show the structure of your Java program. For example, the main part of a class definition should be indented, a method definition's main part should be indented, and when one statement is written inside another, it should be indented one level more.

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

7. A closing curly brace `}` should be on a separate line, and an opening curly brace `{` can be on the same line or a separate line to maintain alignment.

एक दाहिना मझला कोष्टक "}" एक पृथक पंक्ति में होना चाहिए एवं बायां मझला कोष्टक "{" स्वयं एक पंक्ति पर रखा जा सकता है जिससे यह आपस में संरेखित रहे।

8. Avoid placing more than one statement on a single line.

एक से अधिक स्टेटमेंट को एक पंक्ति में न रखें।

9. Break a long line into shorter lines.

एक लम्बी पंक्ति को छोटी-छोटी पंक्तियों में तोड़ा जाना चाहिए।

10. Include some space between method definitions to make the program easier to read.

मेथड परिभाषाओं के बीच कुछ रिक्त स्थान होना चाहिए जिससे प्रोग्राम को पढ़ने में आसानी हो।

11. Use meaningful names for variables, methods, and classes in Java. In Java, variable, method, and package names start with lowercase letters, while class names start with uppercase letters. When a name consists of more than one word, the first letter of each subsequent word is capitalized (camel case), such as `maxMarks`, `SimpleInterest`, etc.

प्रोग्राम में वेरिएबल, मेथड एवं क्लास हेतु सार्थक नामों का प्रयोग किया जाना चाहिए। जावा में वेरिएबल, मेथड, पैकेज के नाम अंग्रेजी के छोटे अक्षरों एवं क्लास के नाम बड़े अक्षरों से शुरू होते हैं। जब किसी नाम में एक से अधिक शब्द हों, तो अगले शब्द का पहला अक्षर बड़ा (कैमल केस) होता है जैसे maxMarks, SimpleInterest इत्यादि।

12. Use "final static" for constants and use "enum" to represent a group of related constants.

कांस्टेंट को दर्शाने के लिए "final static" का प्रयोग करें एवं एक दुसरे से सम्बंधित कांस्टेंट के समूह को दर्शाने के लिए "enum" का उपयोग करें।

13. Each method should have a clear and specific purpose, and the method's definition should not be too long.

प्रत्येक मेथड का एक स्पष्ट एवं विशिष्ट कार्य होना चाहिए एवं मेथड की परिभाषा बहुत लंबी नहीं होनी चाहिए।

14. Avoid using instance variables; instead, use parameters and return values for methods.

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

15. Represent each class with a clear, unique, and identifiable concept. The class should have appropriate use of public, private, and protected sections.

प्रत्येक क्लास को एक स्पष्ट, एकल, पहचान योग्य अवधारणा का प्रतिनिधित्व करना चाहिए एवं क्लास में पब्लिक, प्राइवेट एवं प्रोटेक्टेड भाग का सही-सही उपयोग होना चाहिए।

16. Class variables should generally be in the private section, and get and set methods should be in the public section.

क्लास के वेरिएबल को सामान्य रूप से प्राइवेट भाग में एवं गेट और सेट मेथड को पब्लिक भाग में रखा जाना चाहिए।