ทำไมฉันต้องวาง "ทำ" ในบรรทัดเดียวกันกับ "สำหรับ"

1. สรุป

ผมไม่เข้าใจว่าทำไมฉันต้องกฎ bashate E010

2. รายละเอียด

ฉันใช้bashateสำหรับการตัด.shไฟล์ กฎ E010:

ทำไม่ได้อยู่ในสายเดียวกับสำหรับ

for bashate:

• แก้ไข:

  #!/bin/bash
  for f in bash/*.sh; do
      sashacommand "$f"
  done
  

• ข้อผิดพลาด:

  #!/bin/bash
  for f in bash/*.sh
      do sashacommand "$f"
  done
  

เหตุผลใดที่ฉันต้องการforและdoอยู่ในบรรทัดเดียวกัน

3. ไม่มีประโยชน์

ฉันไม่พบคำตอบสำหรับคำถามของฉันใน:

1. Google
2. บทความเกี่ยวกับแนวทางปฏิบัติในการเข้ารหัสที่ดีที่สุด ( ตัวอย่าง )

3. เอกสาร bashate ฉันพบเพียง :

   ชุดของกฎที่ช่วยให้สิ่งต่าง ๆ สอดคล้องกันในบล็อกควบคุม สิ่งเหล่านี้จะถูกมองข้ามบนเส้นยาวที่มีความต่อเนื่องเพราะการคลายตัวซึ่งเป็น“ น่าสนใจ”

ตัวอย่างโค้ดสองรายการต่อไปนี้ถูกต้องและเทียบเท่า:

for f in bash/*.sh; do
    sashacommand "$f"
done

for f in bash/*.sh
    do sashacommand "$f"
done

คนหลังอาจบอกว่าเป็นการยากที่จะอ่านdoเล็กน้อย obfuscates คำสั่งในร่างกายของวง หากการวนซ้ำมีหลายคำสั่งและคำสั่งถัดไปอยู่ในบรรทัดใหม่การ obfuscation จะถูกเน้นเพิ่มเติม:

for f in *
    do cmd1
    cmd2
done

... แต่การติดธงว่าเป็น "ข้อผิดพลาด" คือความเห็นส่วนตัวของใครบางคน IMHO มากกว่าความจริงวัตถุประสงค์

โดยทั่วไปแล้วเกือบทั้งหมด;อาจถูกแทนที่ด้วยการขึ้นบรรทัดใหม่ ทั้งสอง;และขึ้นบรรทัดใหม่เป็นตัวยกเลิกคำสั่ง doเป็นคำหลักที่หมายถึง "ที่นี่ติดตามสิ่งที่ต้องทำ (ในforลูปนี้)"

for f in *; do ...; done

เป็นเช่นเดียวกับ

for f in *
do
   ...
done

และเป็น

for f in *; do
   ...
done

เหตุผลที่ใช้อย่างใดอย่างหนึ่งคือความสามารถในการอ่านและการประชุมสไตล์ท้องถิ่น / ส่วนตัว

ความเห็นส่วนตัว:

ในส่วนหัวของวนที่ยาวมากฉันคิดว่ามันอาจสมเหตุสมผลที่จะใส่doบรรทัดใหม่เหมือนใน

for i in animals people houses thoughts basketballs bees
do
    ...
done

หรือ

for i in        \
    animals     \
    people      \
    houses      \
    thoughts    \
    basketballs \
    bees
do
    ...
done

เดียวกันจะไปสำหรับthenในifคำสั่ง

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

สังเกตสิ่งที่มันบอกไว้ที่ด้านบนของหน้า:

bashate: pep8 ที่เทียบเท่าสำหรับสคริปต์ทุบตี

PEP8เป็นคู่มือสไตล์สำหรับรหัสหลาม ในขณะที่คนหลามมักจะดูเหมือนจะนำประเด็นสไตล์ของพวกเขาเป็นอย่างมาก^{[อ้างจำเป็น]}มันเป็นเพียงที่แนะนำ เราสามารถสร้างอัพไซด์ขึ้นมาเพื่อวางทั้งคู่doในบรรทัดเดียวกันกับforและวางมันลงบนเส้นของมันเอง

มันเป็นการสนทนาแบบเดียวกับที่ใส่{ในรหัส C เมื่อเริ่มต้นifหรือwhileบล็อก (หรือเช่นนั้น)

บรรทัดด้านล่างในเอกสารประกอบมีกฎที่น่าสนใจอีกข้อหนึ่ง:

E020: การประกาศฟังก์ชันไม่อยู่ในรูปแบบ ^function name {$

ฉันถือว่าจุดที่นี่คือผู้เขียนคู่มือสไตล์คิดว่าการใช้functionคำหลักเป็นสิ่งจำเป็นสำหรับผู้อ่านที่จะรับรู้การประกาศฟังก์ชั่น อย่างไรก็ตามfunction fooเป็นที่ไม่ได้มาตรฐานวิธีการกำหนดฟังก์ชั่น: foo()วิธีมาตรฐานคือ ข้อแตกต่างระหว่างสอง (ใน Bash) คือความแตกต่างระหว่างพอร์ตกับเชลล์มาตรฐานเช่น/bin/shDebian หรือ Ubuntu นั้นยากกว่า

ดังนั้นฉันขอแนะนำให้นำไกด์สไตล์ใด ๆ และทุกอย่างมาด้วยเกลือเม็ดหนึ่งหรือสามเม็ดและตัดสินใจด้วยตัวคุณเองว่าสไตล์ที่ดีที่สุดคืออะไร ตัวตรวจสอบรูปแบบที่ดีช่วยให้ปิดการใช้งานการตรวจสอบบางอย่าง (bashate bashate -i E010,E011จะต้องเพิกเฉยต่อการตรวจสอบสองอย่างนี้) ตัวตรวจสอบรูปแบบที่ยอดเยี่ยมจะช่วยให้คุณสามารถแก้ไขการทดสอบได้เช่นการตรวจสอบ E020 ตรงข้าม

TL; DR: คุณไม่จำเป็นต้องทำ มันเป็นเพียงความเห็นของเพื่อนบางคน

เช่นเดียวกับคนอื่น ๆ ฉันเขียนforลูปแบบนี้มานานหลายทศวรรษ

for F in arg1 arg2 arg*
do
    somecommand "$F"
done

เลย์เอาต์นี้เน้นถึงความจริงที่do ... doneล้อมรอบลำตัววนเช่นปีกกาในภาษา C และอนุญาตให้ขึ้นบรรทัดใหม่เพื่อแยกส่วนประกอบของโครงสร้างวนรอบ

แน่นอนว่ามีสงครามทางศาสนาเกี่ยวกับตำแหน่งที่จะจัดฟันด้วยเช่นกันดังนั้นคุณอาจบอกว่าคณะลูกขุนยังคงออกมา IMHO นี่เป็นสิ่งที่ชัดเจนว่าสิ่งนี้ถูกออกแบบมาเพื่อทำงานอย่างไร Bourne ชื่นชอบตัวคั่นที่ตรงกัน cf if ... fi, case ... esacและความจำเป็นในการอัฒภาคในรุ่นสั้นเผยให้เห็นว่าคุณกำลังทำให้มันสั้นกว่าการออกแบบเดิม ไม่มีอะไรผิดปกติกับที่; gotoความก้าวหน้าด้านเทคโนโลยีและจำนวนมากของสิ่งที่ครั้งหนึ่งเคยดูเหมือนจะเป็นความคิดที่ดีจะขมวดคิ้วตอนนี้เมื่อเป็นเช่น แต่จนกว่าชุมชนการเขียนสคริปต์เชลล์ทั้งหมดจะใช้การตั้งค่าของbashateผู้เขียนคุณไม่ต้องทำอะไรเลย

ฉันประหลาดใจที่ไม่มีใครพูดถึงไวยากรณ์ที่ถูกต้องและพกพาได้:

set alfa bravo charlie
for q do
  echo "$q"
done

สังเกตอย่างระมัดระวังว่าforและdoอยู่ในบรรทัดเดียวกันโดยไม่มีเครื่องหมายอัฒภาค ผล:

alfa
bravo
charlie

คำตอบที่ดีหลายอย่างที่นี่ มักจะนำไกด์สไตล์ที่มีเม็ดเกลือและ IMHO และประสบการณ์มาให้ความห่วงใยในชุมชนที่มีความเชื่อมั่นมากเกินไปเล็กน้อยพอสมควร มันเกือบจะเหมือนที่พวกเขาเชื่อว่าเมื่อพวกเขาได้ในที่สุดฉันก็จุดและสุดท้าย T ข้ามแล้วซอฟต์แวร์จะทำงาน บางครั้งมันใช้เวลามากกว่าสไตล์ที่สมบูรณ์แบบในการลบข้อบกพร่อง ...

เมื่อฉันเริ่มเรียนรู้เชลล์, สคริปต์และ tutes ส่วนใหญ่ใช้รูปแบบอัฒภาคในบรรทัด

for i in "$@"; do
    stuff
done

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

นอกจากนี้คำสั่ง 'while' เป็นตัวเลือกที่ยอดเยี่ยมสำหรับเคล็ดลับเล็กน้อย:

while prep1; prep2; condition; do
    stuff
done

แต่เมื่อคำสั่งเตรียมการมีขนาดค่อนข้างใหญ่และ / หรือเงื่อนไขนั้นซับซ้อน

while
    prep1
    prep2
    condition
do
    stuff
done

และต่อท้ายสิ่งที่ต้องทำในฐานะ "; ทำ" เป็นสิ่งที่ไม่ดีในทางบวก

คุณสามารถเพิ่มความเข้มข้นได้มากกว่านั้น:

while
    if con1; then
      cond2
    elif cond3; then
      cond4
    elif cond5; then
      cond6
    else
      cond7
    fi
do
    stuff
done

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

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

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

for i in whatever
  do stuff
done

ฉันพบว่าค่อนข้างน่าพอใจที่จะดูและมันมี analogues กับในขณะที่ถ้าและกรณี:

while condition
  do stuff
end

if condition
  then stuff1
  else stuff2
fi

case $blah in
  a) stuff1;;
  b) stuff2;;
  c) stuff3;;
  *) stuffInfinity;;
esac

ความชัดเจนและความเป็นระเบียบทั่วไปคือสิ่งที่ Codd * ถามจากคุณ

* Edgar F. Codd พ่อของทฤษฎีฐานข้อมูลเชิงสัมพันธ์