जावा टिप्पणियों में कोड के लॉजिकल सेक्शन को कैसे चिह्नित करें?

Question

जावा कक्षाओं को आम तौर पर तार्किक "ब्लॉक" में विभाजित किया जाता है। क्या इन वर्गों को चिह्नित करने के लिए कोई सम्मेलन है? आदर्श रूप में, यह प्रमुख आईडीई द्वारा समर्थित होगा।

//// Section name here //// 

हालांकि, कुछ संपादकों ने इस के साथ समस्याओं है लगता है:

मैं व्यक्तिगत रूप से इस पद्धति का उपयोग।

उदाहरण के लिए, ऑब्जेक्टिव-सी कोड में आप इस विधि का उपयोग कर सकते हैं:

Answer 1

मैं व्यक्तिगत रूप से इस तरह लाइन विभाजक 80-वर्ण का उपयोग करें,:

public class Client { 

    //================================================================================ 
    // Properties 
    //================================================================================ 

    private String name; 
    private boolean checked; 

    //================================================================================ 
    // Constructors 
    //================================================================================ 

    public Client() { 
    } 

    public Client(String name, boolean checked) { 
     this.name = name; 
     this.checked = checked; 
    } 

    //================================================================================ 
    // Accessors 
    //================================================================================ 

    public String getName() { 
     return name; 
    } 

    public void setName(String name) { 
     this.name = name; 
    } 

    public boolean isChecked() { 
     return checked; 
    } 

    public void setChecked(boolean checked) { 
     this.checked = checked; 
    } 

} 

बेशक

, इस तरह के एक छोटे से POJO के लिए थोड़ा overkill लग सकता है, लेकिन मुझे विश्वास है, यह कुछ बड़ा परियोजनाओं में बहुत उपयोगी साबित हुआ जहां मुझे बड़ी स्रोत फ़ाइलों के माध्यम से ब्राउज़ करना पड़ा और उन तरीकों को तुरंत ढूंढना पड़ा जिनकी मुझे रूचि थी। यह स्रोत कोड संरचना को समझने में भी मदद करता है।

ग्रहण में, मैंने कस्टम टेम्पलेट्स (जावा -> संपादक -> एक्लिप्स के प्राथमिकता संवाद में टेम्पलेट्स) का एक सेट बनाया है जो उन सलाखों को उत्पन्न करता है, उदाहरण के लिए। - SEPA (पहुंचकर्ता के लिए विभाजक) - सेप (गुण के लिए विभाजक) - SEPC (कंस्ट्रक्टर्स के लिए विभाजक) - आदि

मैं भी मानक संशोधित "नया वर्ग" टेम्पलेट (जावा -> संहिता शैली -> ग्रहण प्राथमिकता स्क्रीन में कोड टेम्पलेट्स)

इसके अलावा, Coffee-bytes नामक एक पुरानी ग्रहण प्लगइन है, जिसने एक्लिप्स को कोड के भाग को फोल्ड किया है। मुझे नहीं पता कि यह अभी भी काम करता है, लेकिन मुझे याद आया कि कोई [// सेक्शन] या कुछ जैसी विशेष टिप्पणियां जोड़कर मनमाने ढंग से फोल्ड करने योग्य जोनों को परिभाषित कर सकता है। यह अभी भी हालिया ग्रहण संशोधन में काम कर सकता है, इसलिए एक नज़र डालें।

Answer 2

जहां तक:

#pragma mark - 
#pragma mark Section name here 

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

विरासत या एकत्रीकरण के माध्यम से संबंधित सदस्यों को अलग वर्ग में समूह करना बेहतर है। इसे एक अच्छी ओओपी शैली माना जाता है

Answer 3

मुझे यह भी पसंद आया जब मैं एक्सकोड का उपयोग कर रहा था। ग्रहण के लिए मैं जावा क्लास के माध्यम से नेविगेट करने के लिए ctrl + o (त्वरित रूपरेखा) का उपयोग करता हूं।

Answer 4

काम करने में मदद करने के लिए कोड में अनावश्यक टिप्पणियों/मार्करों का उपयोग करना एक अच्छा अभ्यास नहीं हो सकता है। मुझे एक्सकोड और जावा विकास के बारे में बहुत कम जानकारी नहीं है, लेकिन सभी प्रमुख आईडीई का समर्थन ग्रहण जैसे किसी भी विशेष मार्कर के साथ सदस्यों को ढूंढने के तरीके को रूपरेखा दृश्य का उपयोग करके विधियों और सदस्यों को दिखाता है जिन्हें ctrl+O का उपयोग करके ट्रिगर किया जा सकता है, इंटेलिज (जिसे मैं मैक पर अधिक उपयोग करना पसंद करता हूं और एक सामुदायिक संस्करण भी) में एक ही रूपरेखा अवधारणा है और इसे (ctrl + f12) का उपयोग करके त्वरित रूप से एक्सेस किया जा सकता है। तो यहां मेरा मुद्दा कोड में किसी भी अनावश्यक चिह्न का उपयोग नहीं करता है क्योंकि सभी (या कम से कम अच्छे/सीन) आईडीई स्वचालित रूप से ऐसा कर सकता है।

Answer 5

एक आधुनिक आईडीई आपको कई अलग-अलग तरीकों से अपना कोड देखने की अनुमति देता है, और यहां तक ​​कि इसे पुनर्गठित भी करता है। ग्रहण आपको किसी अन्य पैनल में कर्सर वाले कोड की परिभाषा को देखने की अनुमति देता है।

आपके कोड का कोई भी स्वचालित पुनर्गठन, इस तरह के मार्कअप को तोड़ने का कारण बन जाएगा।

यदि आप समूह बनाना चाहते हैं तो एक ही कक्षा में चीजों को एक साथ रखने पर विचार करें, और विभिन्न वर्गों में चीजें एक साथ नहीं हैं।

Answer 6

ग्रहण @category javadoc annotation परिभाषित करता है ("श्रेणी समर्थन" चिह्नित अनुभाग में स्क्रॉल करें) जो रूपरेखा दृश्य में श्रेणी द्वारा फ़िल्टरिंग को सक्षम बनाता है। बिल्कुल वही नहीं जो आप चाहते हैं। मुझे आश्चर्य है कि किसी ने एक ग्रहण प्लगइन लिखा है जो आपके स्क्रीन शॉट की तरह एक दृश्य प्रदान करता है।

Answer 7

यदि आप अपनी विधियों को क्लस्टर कर सकते हैं, तो विशेष रूप से उस अवधारणा के लिए एक और कक्षा करें जिसे आप किसी सेक्शन में कैप्चर करना चाहते हैं। आगे बढ़ें, फाइलें बनाना मुफ्त है।

Answer 8

इंटेलीजे के लिए मैं क्या पसंद है:

 public void ________________INIT__________________() {}; 

फ़ाइल संरचना में सुंदर लग रही!

Answer 9

इंटेलिज/एंड्रॉइड स्टूडियो के लिए एक अद्भुत समाधान है।
प्रारंभ के साथ:
//region Description
और के साथ समाप्त:
//endregion

कि के लिए शॉर्टकट मेनू में है आप कमान + Alt + टी (Mac) या साथ Ctrl खोल सकते हैं + Alt + टी (विंडोज़)

यदि आपको इसकी आवश्यकता है तो आप अतिरिक्त दृश्य अलगाव के लिए अपनी लाइन भी जोड़ सकते हैं। इस क्षेत्र को किसी भी समारोह की तरह +/- बटन के साथ इच्छानुसार अनुबंधित और विस्तारित किया जा सकता है। तुम भी कमान + Alt + अवधि (Ctrl +Alt + अवधि)

Source साथ क्षेत्रों के बीच नेविगेट कर सकते हैं।

उदाहरण:

//region Parceler Implementation 
//--------------------------------------------------------------------------------------- 
@Override 
public int describeContents() { 
    return 0; 
} 

@Override 
public void writeToParcel(Parcel dest, int flags) { 
    dest.writeParcelable(this.die, 0); 
    dest.writeParcelable(this.dieSprite, 0); 
} 

private DieVm(Parcel in) { 
    this.die = in.readParcelable(Die.class.getClassLoader()); 
    this.dieSprite = in.readParcelable(Sprite.class.getClassLoader()); 
} 

public static final Parcelable.Creator<DieVm> CREATOR = new Parcelable.Creator<DieVm>() { 
    public DieVm createFromParcel(Parcel source) { 
     return new DieVm(source); 
    } 

    public DieVm[] newArray(int size) { 
     return new DieVm[size]; 
    } 
}; 
//--------------------------------------------------------------------------------------- 
//endregion 

Answer 10

प्रदान की एंड्री के जवाब के अलावा, उपयोग करने के लिए // क्षेत्र // endregion, हम डालने [BigAscii पत्र] [1] प्रमुख कोड वर्गों में। तेजी से स्क्रॉल करते समय, यह वास्तव में खड़ा है। इस दृष्टिकोण का एक दोष यह है कि मैं इसकी खोज नहीं कर सकता, इसलिए आपको नीचे दिए गए "बैनर" के नीचे एक खोज शब्द जोड़ना होगा।

Blockquote

// _  _____   _____     _ _ 
// | | | __ \ /\ | __ \  /\  | | | | 
// | | | | | |/\ | |__) | /\ _ _| |_| |__ 
// | | | | | |/ /\ \ | ___/ //\ \| | | | __| '_ \ 
// | |____| |__|/____ \| |  /____ \ |_| | |_| | | | 
// |______|_____/_/ \_\_|  /_/ \_\__,_|\__|_| |_| 
// 
// Search here with: LDAP Auth 

[1]: http://patorjk.com/software/taag/#p=display&c=c%2B%2B&f=Big&t=LDAP प्रमाणीकरण

Answer 11

मैं javadoc का प्रयोग करेंगे; या का उपयोग एक साधारण "विभाजक" (एकल या 3 लाइनों) के रूप में निम्नलिखित:

/** RecyclerOnItemClickListener */ 

/** 
* RecyclerOnItemClickListener 
*/ 

ताकि आईडीई में यह एक अलग विनीत ग्रे टिप्पणी की तुलना में अन्य रंग में दिखाई देता है।