การจัดแนวตั้ง: ใช่หรือไม่? [ปิด]

ตัวอย่างเช่นจัดแนวไม่ใช่แนวตั้ง:

Name:   Hamt
Version:  0.1.0
Cabal-Version:  >= 1.2
License:  BSD3
Author:  Jason Baker

หรือจัดแนวตั้ง:

Name:           Hamt
Version:        0.1.0
Cabal-Version:  >= 1.2
License:        BSD3
Author:         Jason Baker

คุณชอบแบบไหนและทำไม

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

ประหยัดเวลาเมื่อคุณทำเช่นนี้:

Name: Hamt
Version: 0.1.0
Cabal-Version: >= 1.2
License: BSD3
Author: Jason Baker

ไม่ยากเกินไปที่จะอ่าน

ฉันชอบลูกผสม:

Name    : Hamt
Version : 0.1.0
Cabal-Version :  >= 1.2
License : BSD3
Author  : Jason Baker

ซึ่งเป็นจำนวน 2 หลักโดยมีข้อยกเว้นสำหรับเส้นตามโอกาสที่ยาวกว่าเส้นล้อมรอบ - เพื่อป้องกันไม่ให้เส้นส่วนใหญ่เว้นระยะห่าง

นี่เป็นอีกรูปแบบหนึ่งสำหรับเค้าโครงรายการโดยอิงจากประสบการณ์ทั้งสองรวมถึงการศึกษาจากหลักสูตรมหาวิทยาลัยที่ฉันใช้ในการโต้ตอบระหว่างมนุษย์กับคอมพิวเตอร์และหนังสือหลายเล่มที่ฉันได้อ่าน (G) UI การออกแบบและการออกแบบกราฟิก ฉันใช้มันสำหรับการโต้ตอบและเมื่อฉันมีพลังงาน / เวลาสำหรับ CSS (ไม่ปกติสำหรับรหัสว่า)

          Name : Hamt
       Version : 0.1.0
 Cabal-Version : >= 1.2
       License : BSD3
        Author : Jason Baker

เช่นเดียวกับคนอื่น ๆ ทุกคนมันมีข้อดีข้อเสีย

ข้อดี:

• การแบ่งภาพที่ชัดเจนแยกข้อมูลจากป้ายกำกับ
• รูปลักษณ์กราฟิกดีไซน์ระดับมืออาชีพที่น่าพึงใจ (โดยเฉพาะสำหรับไฟล์ที่ผ่านการสรุปและเผยแพร่แล้ว)
• ข้อมูลใกล้กับฉลากมากขึ้นทำให้เชื่อมโยงได้ง่ายขึ้น (ลดโอกาสในการอ่านข้ามบรรทัดไปยังข้อมูลที่ไม่ถูกต้อง)
• เหมาะอย่างยิ่งสำหรับรูปแบบกล่องโต้ตอบ

จุดด้อย:

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

HTH

ฉันชอบอันแรก แต่ไม่มีแท็บ (ซึ่งฉันเดาว่าว่าง); เพียงหนึ่งช่องว่างแทน สำหรับฉันนั้นง่ายต่อการอ่านเมื่อข้อมูลไม่ "คล้ายกัน" เช่นในกรณีที่กำหนด นอกจากนี้ยังทำให้ยากขึ้น (ในขณะที่แก้ไขข้อมูลดังกล่าว) เพื่อ "อ่านแถวผิด" เช่นเมื่อคุณมีสามแถวพร้อมกันขอบอกหมายเลขรุ่น และในขณะที่แก้ไขหนึ่งคุณจะแก้ไขอีกอันโดยบังเอิญ

อย่างไรก็ตามเมื่อข้อมูลมีความคล้ายคลึงกันคุณควรใส่ไว้ในคอลัมน์อย่างในตัวอย่างที่สองของคุณ (มีเพียงไม่เหมือนกัน แต่คุณจะได้รับคะแนน)

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


สำหรับสองเซ็นต์ของฉันฉันชอบรุ่นที่สองมากกว่า ฉันชอบสิ่งนี้ที่สุด:

Name            : Hamt
Version         : 0.1.0
Cabal-Version   : >= 1.2
License         : BSD3
Author          : Jason Baker

มันเป็นเวอร์ชันที่อ่านได้ง่ายและใช้งานง่ายที่สุดที่ฉันได้ลอง ข้อเสียจริงเพียงอย่างเดียวคือฉันต้องคิดออกว่าฟิลด์ที่กว้างที่สุดคืออะไรและบางครั้งก็ต้องขยายทั้งหมดเมื่อกว้างเกินไป (มักเกิดขึ้นกับ CSS) อย่างไรก็ตามมีบางจุดที่ต้องพิจารณา

ครั้งแรกฉันมักชอบแท็บมากกว่าเมื่อเทียบกับช่องว่างอย่างไรก็ตามการตั้งค่าแท็บที่แท้จริงนั้นแตกต่างกันไป ตัวอย่างเช่นฉันคุ้นเคยกับแท็บ 4 สเปซสำหรับรหัส C (++) หรือ HTML และแท็บ 2 สเปซสำหรับรหัสปาสคาลหรือแอสเซมเบลอร์ในขณะที่บางสิ่งเช่น CSS ฉันไม่มีค่ากำหนดสำหรับความกว้างแท็บ การเปลี่ยนแปลงนี้ทำให้สิ่งต่าง ๆ ซับซ้อนพอสมควร แต่จากนั้นบรรณาธิการที่ฉันใช้จะพ่นในภาวะแทรกซ้อนของตัวเอง บรรณาธิการบางคนให้คุณตั้งค่าการตั้งค่าแท็บ TAB ต่อภาษา แต่บางคนก็ไม่ได้ (แม้แต่บางคนที่มีโปรไฟล์ต่างกัน)

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

ฉันชอบแท็บโดยทั่วไปเพราะถึงแม้จะมีรหัสความกว้างคงที่ฉันก็รู้สึกหงุดหงิดที่จะต้องเลื่อนเคอร์เซอร์ผ่านช่องว่างหลาย ๆ แท็บสำหรับแต่ละแท็บ ฉันจำได้ว่า Borland IDEs เก่ามีตัวเลือกในการเลื่อนผ่านแท็บ (โดยเฉพาะความยาวทั้งหมดของช่องว่าง) เป็นเอนทิตีเดียวแทนที่จะเป็นเว้นวรรคสอง, สี่และอื่น ๆ ทำให้การแทรกแท็บเป็นช่องว่างในทางปฏิบัติในขณะที่ทำให้การนำทางเคอร์เซอร์ทำได้ง่ายและรวดเร็ว น่าเสียดายที่ฉันไม่เห็นบรรณาธิการ Windows ที่ทันสมัยและสามารถทำเช่นนั้นได้

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


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