จะทำเครื่องหมายส่วนตรรกะของโค้ดในข้อคิดเห็น Java ได้อย่างไร

โดยทั่วไปคลาส Java จะแบ่งออกเป็น "บล็อก" เชิงตรรกะ มีแบบแผนในการทำเครื่องหมายส่วนเหล่านี้หรือไม่? ตามหลักการแล้ว IDE หลัก ๆ จะได้รับการสนับสนุน

ฉันใช้วิธีนี้เป็นการส่วนตัว:

//// Section name here ////

อย่างไรก็ตามดูเหมือนว่าบรรณาธิการบางคนจะมีปัญหากับเรื่องนี้

ตัวอย่างเช่นในรหัส Objective-C คุณสามารถใช้วิธีนี้:

#pragma mark -
#pragma mark Section name here

ซึ่งจะส่งผลให้เมนูใน XCode มีลักษณะดังนี้:

โดยส่วนตัวฉันใช้ตัวคั่นบรรทัด 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 ขนาดเล็กเช่นนี้ แต่เชื่อฉันเถอะว่ามันมีประโยชน์มากในโปรเจ็กต์ขนาดใหญ่บางโครงการที่ฉันต้องเรียกดูไฟล์ต้นฉบับขนาดใหญ่และค้นหาวิธีการที่ฉันสนใจอย่างรวดเร็วนอกจากนี้ยังช่วยให้เข้าใจ โครงสร้างซอร์สโค้ด

ใน Eclipse ฉันได้สร้างชุดเทมเพลตที่กำหนดเอง (Java -> Editor -> เทมเพลตในกล่องโต้ตอบการกำหนดลักษณะของ Eclipse) ที่สร้างแถบเหล่านั้นเช่น - ตัวคั่น (SEParator for Accessors) - sepp (SEParator for Properties) - sepc (SEParator for Constructors) - ฯลฯ

ฉันยังแก้ไขเทมเพลต "คลาสใหม่" มาตรฐาน (Java -> รูปแบบโค้ด -> เทมเพลตโค้ดในหน้าจอ Eclipse Preferences)

นอกจากนี้ยังมีปลั๊กอิน Eclipse เก่าที่เรียกว่าCoffee-bytesซึ่งปรับปรุงวิธีที่ Eclipse พับส่วนของโค้ด ฉันไม่รู้ว่ามันยังใช้งานได้หรือเปล่า แต่ฉันจำได้ว่าเราสามารถกำหนดโซนที่พับเก็บได้เองโดยการเพิ่มความคิดเห็นพิเศษเช่น // [SECTION] หรืออะไรสักอย่าง อาจยังใช้งานได้ในการแก้ไข Eclipse ล่าสุดดังนั้นลองดู

สำหรับสตูดิโอ intellij / android มีโซลูชันที่น่าทึ่ง
เริ่มต้นด้วย:
//region Description
และลงท้ายด้วย:
//endregion

ทางลัดที่อยู่ในเมนูที่คุณสามารถเปิดด้วยCommand+ Alt+ T(Mac) หรือCtrl+ Alt+ T(Windows)

คุณยังสามารถเพิ่มเส้นของคุณเองเพื่อแยกภาพเพิ่มเติมได้หากต้องการ ภูมิภาคสามารถหดและขยายได้ตามต้องการด้วยปุ่ม +/- เหมือนกับฟังก์ชันใด ๆ คุณยังสามารถนำทางระหว่างภูมิภาคต่างๆด้วยCommand+ Alt+ Period( Ctrl+ Alt+Period )

ที่มาแหล่ง

ตัวอย่าง:

//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

Eclipse กำหนดคำอธิบายประกอบ @category javadoc (เลื่อนไปที่ส่วนที่ระบุว่า "การสนับสนุนหมวดหมู่") ซึ่งเปิดใช้งานการกรองตามหมวดหมู่ในมุมมองเค้าร่าง ไม่ตรงตามที่คุณต้องการ ฉันแปลกใจที่ไม่มีใครเขียนปลั๊กอิน Eclipse ที่ให้มุมมองเหมือนกับภาพหน้าจอของคุณ

ฉันชอบตอนนั้นด้วยเมื่อฉันใช้ xcode สำหรับ eclipse ฉันใช้ ctrl + o (โครงร่างด่วน) เพื่อนำทางผ่านคลาส Java

การใช้ความคิดเห็น / เครื่องหมายที่ไม่จำเป็นในโค้ดเพื่อช่วยในการทำงานอาจไม่ใช่แนวทางปฏิบัติที่ดี ฉันมีความคิดเล็กน้อยเกี่ยวกับการพัฒนา xcode และ java แต่การสนับสนุนของ IDE ที่สำคัญทั้งหมดในการค้นหาสมาชิกโดยไม่ต้องใช้เครื่องหมายพิเศษใด ๆ เช่น eclipse จะแสดงวิธีการและสมาชิกโดยใช้มุมมองเค้าร่างซึ่งสามารถเรียกใช้โดยใช้ctrl+OIntellij (ซึ่งฉันชอบใช้มากกว่าบน mac และมี ฉบับชุมชนด้วย) มีแนวคิดโครงร่างเดียวกันและสามารถเข้าถึงได้อย่างรวดเร็วโดยใช้ (ctrl + f12) ดังนั้นประเด็นของฉันที่นี่คืออย่าใช้มาร์กอัปที่ไม่จำเป็นในโค้ดเนื่องจาก IDE ทั้งหมด (หรืออย่างน้อยดี / มีเหตุผล) สามารถทำได้โดยอัตโนมัติ

เท่าที่ฉันรู้ไม่มีสิ่งที่เรียกว่าข้อกำหนดที่รองรับสำหรับการจัดกลุ่มสมาชิกชั้นเรียนเข้าด้วยกัน คุณสามารถใช้รูปแบบการแสดงความคิดเห็นที่คุณชอบได้ แต่มีโอกาสที่เครื่องมือใด ๆ จะไม่รองรับ

จะเป็นการดีกว่าที่จะจัดกลุ่มสมาชิกที่เกี่ยวข้องเป็นคลาสแยกกันผ่านการสืบทอดหรือการรวมกลุ่ม นี่ถือเป็นรูปแบบ OOP ที่ดี

ฉันจะใช้javadoc ; หรือใช้สิ่งต่อไปนี้เป็น "ตัวคั่น" แบบธรรมดา (บรรทัดเดียวหรือ 3 บรรทัด):

/** RecyclerOnItemClickListener */

/** 
 * RecyclerOnItemClickListener
 */

ดังนั้นใน IDE จึงปรากฏเป็นสีอื่นนอกเหนือจากสีเทาที่แสดงความคิดเห็นที่ไม่สร้างความรำคาญ

นอกเหนือจากคำตอบของ Andrey ในการใช้ // region // 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 Auth

IDE ที่ทันสมัยช่วยให้คุณสามารถดูรหัสของคุณได้หลายวิธีและแม้แต่จัดระเบียบใหม่ Eclipse ยังอนุญาตให้คุณดูคำจำกัดความของรหัสที่คุณมีเคอร์เซอร์อยู่ในแผงควบคุมอื่น

การจัดระเบียบโค้ดของคุณใหม่โดยอัตโนมัติจะทำให้มาร์กอัปดังกล่าวพังลง

หากคุณต้องการจัดกลุ่มให้พิจารณารวมสิ่งของที่อยู่ในชั้นเรียนเดียวกันและสิ่งของที่ไม่ได้อยู่ร่วมกันในชั้นเรียนต่างๆ

ถ้าคุณสามารถจัดกลุ่มเมธอดของคุณได้ให้ทำคลาสอื่นโดยเฉพาะสำหรับแนวคิดนั้นที่คุณต้องการจับภาพในส่วน สร้างไฟล์ได้ฟรี

สำหรับ IntelliJ ฉันชอบ:

        public void ________________INIT__________________() {};

ดูสวยในโครงสร้างไฟล์!