DevOps Bootcamp · บทเรียน

การตรวจรูปแบบและตรวจสอบคุณภาพโค้ด

เพิ่มเครื่องมือวิเคราะห์โค้ดแบบคงที่และตรวจรูปแบบลงในเวิร์กโฟลว์ เพื่อรักษามาตรฐานการเขียนโค้ดให้สอดคล้องกัน

การตรวจรูปแบบและตรวจสอบคุณภาพโค้ด เป็นบทเรียน DevOps Bootcamp ฟรีบน CoddyKit นี่คือบทเรียนที่ 3 จากทั้งหมด 4 บทเรียน คุณสามารถอ่านบทเรียนทั้งหมดด้านล่างฟรี — จากนั้นลองปฏิบัติด้วยตัวคุณเองในเบราว์เซอร์พร้อมตัวแก้ไขโค้ดในตัวและติวเตอร์ AI ตลอด 24/7 บทเรียนนี้เป็นส่วนหนึ่งของเส้นทางการเรียน DevOps Bootcamp และความก้าวหน้าของคุณจะซิงค์ข้ามเว็บและแอป CoddyKit คอร์ส DevOps Bootcamp มีบทเรียนทั้งหมด 4 บทเรียน

คุณภาพโค้ดคืออะไร

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

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

ทำความรู้จักเครื่องมือตรวจโค้ด

การตรวจโค้ด คือกระบวนการตรวจสอบข้อผิดพลาดด้านการเขียนโปรแกรมและรูปแบบโค้ด ลองนึกภาพว่าเป็นเครื่องมือตรวจการสะกดสำหรับโค้ดของคุณ!

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

เครื่องมือตรวจโค้ดไม่ได้เรียกใช้โค้ด แต่จะวิเคราะห์โครงสร้างของโค้ด

การวิเคราะห์โค้ดแบบสแตติก

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

เครื่องมือวิเคราะห์แบบสแตติกสามารถระบุสิ่งต่อไปนี้ได้

ช่องโหว่ด้านความปลอดภัยที่อาจเกิดขึ้น เช่น ความเสี่ยงจากการแทรกคำสั่ง SQL
คอขวดด้านประสิทธิภาพ
รูปแบบข้อบกพร่องที่ซับซ้อนหรือโค้ดที่ไม่สามารถเข้าถึงได้

ทั้งการตรวจโค้ดและการวิเคราะห์แบบสแตติกช่วยปรับปรุงคุณภาพโค้ดโดยรวม

ประโยชน์ของโค้ดที่สะอาด

การผสานการตรวจโค้ดและการวิเคราะห์แบบสแตติกเข้ากับเวิร์กโฟลว์การพัฒนาของคุณมีข้อดีมากมาย

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

เครื่องมือที่ใช้ในงาน

ภาษาโปรแกรมแต่ละภาษามีเครื่องมือตรวจโค้ดและวิเคราะห์แบบสแตติกยอดนิยมของตนเอง

JavaScript: ESLint, Prettier
Python: Flake8, Pylint, Black
Java: Checkstyle, SonarQube

สำหรับบทเรียนนี้ เราจะเน้นที่ Flake8 สำหรับ Python ซึ่งเป็นเครื่องมือที่เรียบง่ายแต่ทรงพลัง

การตรวจโค้ด Python ด้วย Flake8

Flake8 รวมเครื่องมือหลายตัว ได้แก่ Pyflakes, pycodestyle และ McCabe เพื่อตรวจสอบโค้ด Python ของคุณให้เป็นไปตามแนวทางรูปแบบโค้ด PEP 8 และตรวจหาข้อผิดพลาดที่พบบ่อย

PEP 8 เป็นคู่มือรูปแบบโค้ดอย่างเป็นทางการของ Python ซึ่งส่งเสริมโค้ดที่อ่านง่ายและสม่ำเสมอ Flake8 ช่วยให้คุณปฏิบัติตามแนวทางนี้ได้โดยอัตโนมัติ

การเรียกใช้ Flake8 ในเครื่อง

นี่คือสคริปต์ Python ขนาดเล็กที่มีปัญหาด้านรูปแบบอยู่บางส่วน หากต้องการเรียกใช้ Flake8 กับสคริปต์นี้ โดยทั่วไปคุณจะติดตั้งเครื่องมือนี้ก่อน (`pip install flake8`) จากนั้นจึงเรียกใช้ `flake8 your_script.py` ในเทอร์มินัล

สังเกตการเว้นวรรคและการเลือกใช้รูปแบบต่าง ๆ Flake8 จะแจ้งปัญหาเหล่านี้!

def calculate_sum(  num1, num2 ):
    total = num1 + num2
    print ( total )

calculate_sum( 5, 7 )

การตรวจโค้ดในไปป์ไลน์ CI ของคุณ

เพื่อให้คุณภาพโค้ดของทีมสม่ำเสมอ คุณสามารถทำการตรวจโค้ดโดยอัตโนมัติด้วย GitHub Actions ซึ่งหมายความว่าทุกครั้งที่มีการส่งโค้ดขึ้นไปหรือเปิดคำขอผสานโค้ด เครื่องมือตรวจโค้ดจะทำงานโดยอัตโนมัติ

หากเครื่องมือตรวจโค้ดพบปัญหา คุณสามารถตั้งค่าให้เวิร์กโฟลว์ล้มเหลวได้ เพื่อป้องกันไม่ให้โค้ดคุณภาพต่ำถูกรวมเข้ากับสาขา main

ตัวอย่างเวิร์กโฟลว์ Flake8

นี่คือตัวอย่างเวิร์กโฟลว์ GitHub Actions พื้นฐาน (`.github/workflows/lint.yml`) ที่เรียกใช้ Flake8 กับโครงการ Python ของคุณ เวิร์กโฟลว์นี้จะทำงานเมื่อมีการส่งโค้ดขึ้นไปหรือมีคำขอผสานโค้ดไปยังสาขา main

name: Python Linting

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.x'
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install flake8
    - name: Run Flake8
      run: |
        flake8 . --count --show-source --statistics

การอ่านรายงานการตรวจโค้ด

เมื่อ Flake8 ทำงาน เครื่องมือจะแสดงรายการปัญหา แต่ละบรรทัดโดยทั่วไปประกอบด้วยชื่อไฟล์ หมายเลขบรรทัด หมายเลขคอลัมน์ รหัสข้อผิดพลาด เช่น E231 และ W292 และคำอธิบาย

E (ข้อผิดพลาด): โดยทั่วไปคือการละเมิดไวยากรณ์หรือรูปแบบที่ร้ายแรง
W (คำเตือน): ปัญหาด้านรูปแบบที่มีความสำคัญน้อยกว่า

เป้าหมายของคุณมักเป็นการทำให้ไปป์ไลน์สะอาดปราศจากข้อผิดพลาดหรือคำเตือนจากการตรวจโค้ด!

การตรวจสอบความรู้เรื่องการตรวจโค้ด

คุณได้เรียนรู้เกี่ยวกับความสำคัญของการตรวจโค้ดและการวิเคราะห์แบบสแตติกแล้ว มาทดสอบความเข้าใจกัน!

สรุป: การตรวจโค้ดเพื่อคุณภาพ

เก่งมาก! คุณได้สำรวจว่าการตรวจโค้ดและการวิเคราะห์โค้ดแบบสแตติกมีความสำคัญอย่างยิ่งต่อการรักษาคุณภาพโค้ดให้อยู่ในระดับสูงในการพัฒนาซอฟต์แวร์สมัยใหม่

เราได้ให้คำจำกัดความของการตรวจโค้ดและการวิเคราะห์แบบสแตติก
เรียนรู้ประโยชน์ของสิ่งเหล่านี้ต่อความสม่ำเสมอและการป้องกันข้อบกพร่อง
เห็นวิธีผสานเครื่องมืออย่าง Flake8 เข้ากับเวิร์กโฟลว์ของ GitHub Actions

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

คำถามที่พบบ่อย

บทเรียน “การตรวจรูปแบบและตรวจสอบคุณภาพโค้ด” ฟรีหรือไม่

ใช่ — ข้อความเต็มของ “การตรวจรูปแบบและตรวจสอบคุณภาพโค้ด” ฟรีให้อ่านที่นี่บนเว็บ เพื่อปฏิบัติแบบโต้ตอบ (ตัวแก้ไขโค้ดในตัวและติวเตอร์ AI ตลอด 24/7) และปลดล็อคส่วนที่เหลือของคอร์ส DevOps Bootcamp ให้อัปเกรดเป็น CoddyKit PRO คอร์ส DevOps Bootcamp มีบทเรียนทั้งหมด 4 บทเรียน

คุณจะเรียนรู้อะไรในบทเรียน “การตรวจรูปแบบและตรวจสอบคุณภาพโค้ด”

เพิ่มเครื่องมือวิเคราะห์โค้ดแบบคงที่และตรวจรูปแบบลงในเวิร์กโฟลว์ เพื่อรักษามาตรฐานการเขียนโค้ดให้สอดคล้องกัน คุณปฏิบัติ DevOps Bootcamp ด้วยโค้ดที่ใช้งานได้จริงที่คุณเรียกใช้โดยตรงในเบราว์เซอร์ และติวเตอร์ AI ตลอด 24/7 ตอบคำถามของคุณขณะที่คุณไปผ่านบทเรียน

คุณต้องมีประสบการณ์ก่อนที่จะเริ่มเรียน DevOps Bootcamp หรือไม่

ไม่จำเป็นต้องมีประสบการณ์มาก่อน DevOps Bootcamp บน CoddyKit ออกแบบมาสำหรับผู้เริ่มต้นไปจนถึงผู้เรียนขั้นสูง คุณสามารถเริ่มต้นที่นี่หรือเริ่มจากตัวแรกและเรียนด้วยความเร็วของคุณเอง นี่คือบทเรียนที่ 3 จากทั้งหมด 4 บทเรียน

บทเรียน “การตรวจรูปแบบและตรวจสอบคุณภาพโค้ด” ใช้เวลานานแค่ไหน

บทเรียน CoddyKit ส่วนใหญ่ใช้เวลาประมาณ 5–10 นาที แต่ละบทเรียนจึงสั้นและเป็นแบบโต้ตอบ คุณสามารถก้าวหน้าอย่างต่อเนื่องและกลับมาเรียนต่อจากตรงที่เพิ่งหยุดบนเว็บและแอปได้เลย

ฉันเขียนและรันโค้ดในบทเรียน DevOps Bootcamp นี้ได้ไหม

ได้ บทเรียน DevOps Bootcamp ทุกบทมีตัวแก้ไขโค้ดในตัว คุณจึงเขียนและรันโค้ดจริงได้เลยในเบราว์เซอร์ และได้รับข้อเสนอแนะจาก AI ในทันที — ไม่ต้องติดตั้งในเครื่องของคุณ

บทเรียนทั้งหมดในหลักสูตรนี้

← กลับไปที่ DevOps Bootcamp