การตั้งชื่อ คอมเมนต์ และรูปแบบที่ขยายได้
ข้อตกลงที่ช่วยให้โครงการอ่านได้ง่าย
การตั้งชื่อ คอมเมนต์ และรูปแบบที่ขยายได้ เป็นบทเรียน DevOps Bootcamp ฟรีบน CoddyKit นี่คือบทเรียนที่ 4 จากทั้งหมด 4 บทเรียน คุณสามารถอ่านบทเรียนทั้งหมดด้านล่างฟรี — จากนั้นลองปฏิบัติด้วยตัวคุณเองในเบราว์เซอร์พร้อมตัวแก้ไขโค้ดในตัวและติวเตอร์ AI ตลอด 24/7 บทเรียนนี้เป็นส่วนหนึ่งของเส้นทางการเรียน DevOps Bootcamp และความก้าวหน้าของคุณจะซิงค์ข้ามเว็บและแอป CoddyKit คอร์ส DevOps Bootcamp มีบทเรียนทั้งหมด 4 บทเรียน
รูปแบบไม่ใช่สิ่งที่เลือกได้
เพลย์บุ๊กถูกอ่านบ่อยกว่าที่ถูกเขียนมาก การตั้งชื่อและรูปแบบที่สม่ำเสมอ จะเปลี่ยนสคริปต์ส่วนตัวให้เป็นระบบอัตโนมัติที่พร้อมใช้ในทีม ✨
ตั้งชื่องานทุกงานเสมอ
ตั้ง ชื่อ ที่ชัดเจนให้กับงานทุกงาน งานที่มีชื่อจะทำให้ผลลัพธ์การทำงานอ่านง่าย และบอกเจตนาให้เพื่อนร่วมทีมเข้าใจได้ทันที
- name: Install the nginx web server
package:
name: nginx
state: presentเขียนชื่อเป็นการกระทำ
เขียนชื่อให้เป็นการกระทำที่ชัดเจน เช่น ติดตั้ง nginx หรือสร้างผู้ใช้สำหรับการนำไปใช้งาน เมื่อเพลย์ทำงาน ชื่อเหล่านี้จะอ่านเหมือนรายการตรวจสอบ
เลือกใช้โมดูลโดยตรง
ควรเลือกใช้ โมดูล จริงแทนโมดูล shell หรือ command โมดูลมีคุณสมบัติทำงานซ้ำได้โดยไม่ก่อให้เกิดการเปลี่ยนแปลงที่ไม่จำเป็นและอธิบายตัวเองได้ ส่วนคำสั่งดิบไม่มีคุณสมบัติเหล่านี้
ใช้ YAML ไม่ใช่ key=value
เขียนอาร์กิวเมนต์ของโมดูลด้วย รูปแบบบล็อก YAML ที่อ่านง่าย โดยใช้หนึ่งคีย์ต่อบรรทัด แทนการยัดทุกอย่างไว้ในสตริงบรรทัดเดียว
- name: Ensure dir exists
file:
path: /opt/app
state: directoryความคิดเห็นอธิบายเหตุผล
ใช้ # ความคิดเห็น เพื่ออธิบายเหตุผล ไม่ใช่สิ่งที่คำสั่งทำ ชื่องานบอกสิ่งที่ทำอยู่แล้ว ส่วนความคิดเห็นใช้บันทึกเหตุผลหรือข้อควรระวัง
# Pin version: 1.20 broke our TLS config
- name: Install nginx 1.18
package:
name: nginx=1.18*ตั้งชื่อตัวแปรให้สม่ำเสมอ
ตั้งชื่อตัวแปรด้วย lower snake_case และเติมชื่อบทบาทไว้หน้าตัวแปรของบทบาท เพื่อหลีกเลี่ยงชื่อซ้ำกัน เช่น nginx_port
ใส่เครื่องหมายคำพูดเมื่อไม่แน่ใจ
ใส่เครื่องหมายคำพูดให้ค่าที่ขึ้นต้นด้วย {{ หรือค่าที่อาจถูกอ่านเป็นตัวเลขหรือค่าบูลีน เพื่อไม่ให้ YAML เดาประเภทผิด
msg: "{{ greeting }}"
version: "1.10"การเยื้องสองช่องว่าง
ใช้ สองช่องว่าง ต่อหนึ่งระดับและห้ามใช้แท็บ YAML แยกความหมายตามช่องว่าง ดังนั้นการเยื้องที่ปะปนกันจะทำให้การวิเคราะห์โครงสร้างล้มเหลว
ให้ ansible-lint บังคับใช้
เรียกใช้ ansible-lint เพื่อตรวจจับปัญหาด้านรูปแบบและแนวทางปฏิบัติที่ดีโดยอัตโนมัติ ให้เครื่องมือช่วยตรวจสอบแบบแผน เพื่อให้การทบทวนมุ่งเน้นที่ตรรกะ
ansible-lint site.ymlไฟล์ขนาดเล็กที่มีหน้าที่ชัดเจน
ให้แต่ละไฟล์ทำ หน้าที่เดียว ไฟล์งานที่สั้นและตั้งชื่อชัดเจนจะทดสอบ นำกลับมาใช้ซ้ำ และทำความเข้าใจได้ง่ายกว่าไฟล์ขนาดใหญ่ที่ทำหลายอย่าง 🎯
ตรวจสอบความเข้าใจ
เหตุผลหลักที่ควรใส่ชื่อให้กับงานทุกงานคืออะไร
สรุปทบทวน
คุณได้เรียนรู้การตั้งชื่อให้งานทุกงาน การเลือกใช้โมดูลแทน shell การเขียน YAML ให้ชัดเจน การแสดงความคิดเห็นถึงเหตุผล และการให้ ansible-lint บังคับใช้รูปแบบ ✅
คำถามที่พบบ่อย
บทเรียน “การตั้งชื่อ คอมเมนต์ และรูปแบบที่ขยายได้” ฟรีหรือไม่
ใช่ — ข้อความเต็มของ “การตั้งชื่อ คอมเมนต์ และรูปแบบที่ขยายได้” ฟรีให้อ่านที่นี่บนเว็บ เพื่อปฏิบัติแบบโต้ตอบ (ตัวแก้ไขโค้ดในตัวและติวเตอร์ AI ตลอด 24/7) และปลดล็อคส่วนที่เหลือของคอร์ส DevOps Bootcamp ให้อัปเกรดเป็น CoddyKit PRO คอร์ส DevOps Bootcamp มีบทเรียนทั้งหมด 4 บทเรียน
คุณจะเรียนรู้อะไรในบทเรียน “การตั้งชื่อ คอมเมนต์ และรูปแบบที่ขยายได้”
ข้อตกลงที่ช่วยให้โครงการอ่านได้ง่าย คุณปฏิบัติ DevOps Bootcamp ด้วยโค้ดที่ใช้งานได้จริงที่คุณเรียกใช้โดยตรงในเบราว์เซอร์ และติวเตอร์ AI ตลอด 24/7 ตอบคำถามของคุณขณะที่คุณไปผ่านบทเรียน
คุณต้องมีประสบการณ์ก่อนที่จะเริ่มเรียน DevOps Bootcamp หรือไม่
ไม่จำเป็นต้องมีประสบการณ์มาก่อน DevOps Bootcamp บน CoddyKit ออกแบบมาสำหรับผู้เริ่มต้นไปจนถึงผู้เรียนขั้นสูง คุณสามารถเริ่มต้นที่นี่หรือเริ่มจากตัวแรกและเรียนด้วยความเร็วของคุณเอง นี่คือบทเรียนที่ 4 จากทั้งหมด 4 บทเรียน
บทเรียน “การตั้งชื่อ คอมเมนต์ และรูปแบบที่ขยายได้” ใช้เวลานานแค่ไหน
บทเรียน CoddyKit ส่วนใหญ่ใช้เวลาประมาณ 5–10 นาที แต่ละบทเรียนจึงสั้นและเป็นแบบโต้ตอบ คุณสามารถก้าวหน้าอย่างต่อเนื่องและกลับมาเรียนต่อจากตรงที่เพิ่งหยุดบนเว็บและแอปได้เลย
ฉันเขียนและรันโค้ดในบทเรียน DevOps Bootcamp นี้ได้ไหม
ได้ บทเรียน DevOps Bootcamp ทุกบทมีตัวแก้ไขโค้ดในตัว คุณจึงเขียนและรันโค้ดจริงได้เลยในเบราว์เซอร์ และได้รับข้อเสนอแนะจาก AI ในทันที — ไม่ต้องติดตั้งในเครื่องของคุณ
บทเรียนทั้งหมดในหลักสูตรนี้
- โครงสร้างไดเรกทอรีที่แนะนำ
- ไดเรกทอรี group_vars และ host_vars
- แยก Playbook ด้วย import และ include
- การตั้งชื่อ คอมเมนต์ และรูปแบบที่ขยายได้