Chuyển tới nội dung chính

Code Analysis

Bảng điều khiển Phân tích Mã là một công cụ để phân tích sâu về chất lượng mã, theo dõi các chỉ số như độ tin cậy, bảo mật và khả năng bảo trì nhằm cải thiện chất lượng mã và ngăn ngừa các vấn đề tiềm ẩn một cách chủ động.

Bảng điều khiển Phân tích Mã​

Từ Menu Bên, chọn Bảng điều khiển/Code Analysis:

Chức năng chính​

Từ Code Analysis Dashboard, các hành động dưới đây có thể được thực hiện:

  1. Tìm kiếm một báo cáo, mà là:

    • Lọc theo Dự án
    • Lọc theo Dự án và Hồ sơ của dự án
    • Lọc theo Dự án và Hồ sơ và ứng dụng của hồ sơ
    • Lọc theo Dự án và Nhóm của dự án
    • Lọc theo Dự án và Hồ sơ, nhóm của dự án

  2. Sao chép URL của bảng điều khiển chất lượng mã hiện tại.

  3. Đặt lại bảng điều khiển:

Khi nhấp vào nút Đặt lại, tất cả dữ liệu đã chọn về dự án, hồ sơ, ứng dụng và nhóm được chọn sẽ được đặt lại.

  1. Cấu hình Sonar:

Cho phép người dùng điều hướng đến màn hình Cấu hình Sonar, cho phép người dùng xem chi tiết dự án, chi tiết hồ sơ, chi tiết ứng dụng, tạo cấu hình mới, lấy đồng bộ một cách thủ công, chỉnh sửa cấu hình và xóa cấu hình.

  1. Tùy chỉnh báo cáo hiển thị bằng cách bật hoặc tắt biểu đồ/bảng

  1. Chuyển đổi chế độ xem giữa chế độ Dữ liệu và chế độ Biểu đồ.

  2. Mở rộng biểu đồ báo cáo cụ thể trên Bảng điều khiển.

  3. Chuyển đổi giữa chế độ PR (Yêu cầu kéo) và Non-PR (Không yêu cầu kéo) : With mode PR: bảng minh họa dữ liệu của các commit từ pull request, là các phần của quy trình làm việc pull request, thường được sử dụng để xem xét mã trước khi hợp nhất vào nhánh chính.

With non PR: bảng minh họa dữ liệu của các commit không có pull request, đây là các commit trực tiếp (ví dụ: được đẩy trực tiếp vào nhánh chính hoặc một nhánh khác) không liên quan đến bất kỳ pull request nào.

Theo mặc định, bảng điều khiển được hiển thị ở chế độ PR.

Các thành phần chính​

Bảng điều khiển này cung cấp các chỉ số chính cần thiết để đánh giá chất lượng mã, cho phép các nhà phát triển đánh giá và cải thiện độ tin cậy, bảo mật và khả năng bảo trì của mã nguồn. Các thành phần chính bao gồm:

Line of Code (LOC): Hình dung xu hướng tổng số dòng mã trong mã nguồn, giúp theo dõi sự phát triển của mã.

Sự gia tăng trong LOC phản ánh việc thêm các tính năng mới hoặc sửa đổi, giúp hiểu các thay đổi trong phạm vi hoặc độ phức tạp của dự án.

  • Trục Y (Dòng mã): Đại diện cho tổng số dòng mã trong dự án.
  • Trục X (Thời gian): Hiển thị dòng thời gian, chỉ ra các ngày khi các phép đo dòng mã được thực hiện.

Code Churn: Hiển thị số dòng mã được thêm hoặc xóa theo thời gian, chỉ ra tần suất thay đổi mã, nhằm đánh giá độ ổn định của mã và tần suất sửa đổi.

Tần suất cao có thể chỉ ra các giai đoạn cập nhật tính năng tích cực hoặc tái cấu trúc. Theo dõi biểu đồ này giúp trong nỗ lực duy trì độ ổn định của mã.

  • Trục Y (Thay đổi): Đại diện cho số lượng thay đổi mã, bao gồm các bổ sung, xóa và sửa đổi.
  • Trục X (Ngày): Hiển thị các ngày khi các thay đổi mã xảy ra.

Reliability: Hiển thị số lượng lỗi phát hiện trong mã nguồn, đánh giá độ tin cậy của mã.

Chỉ số này đánh giá độ tin cậy của mã, với số lượng lỗi cao hơn cho thấy độ ổn định thấp hơn. Nó giúp xác định các khu vực cần cải thiện chất lượng. Đại diện cho tổng số lỗi đã được xác định. Xu hướng giảm trong số lượng lỗi cho thấy chất lượng mã đang được cải thiện.

Test Coverage: Đại diện cho tỷ lệ phần trăm mã được kiểm tra.

Độ phủ kiểm tra là rất quan trọng để đánh giá sự ổn định của mã. Độ phủ cao hơn có nghĩa là nhiều mã hơn được kiểm tra, giảm khả năng xảy ra lỗi không mong muốn.

Duplicated Blocks: Hiển thị số lượng khối mã bị trùng lặp trong mã nguồn.

Giảm thiểu sự trùng lặp mã cải thiện khả năng đọc và bảo trì.

Security: Hiển thị số lượng lỗ hổng bảo mật tiềm ẩn, đánh giá bảo mật mã.

Chỉ số này đánh giá rủi ro bảo mật, với ít lỗ hổng hơn cho thấy bảo mật được cải thiện. Số lượng lỗ hổng cao hơn có nghĩa là rủi ro lớn hơn về việc rò rỉ dữ liệu hoặc xâm phạm hệ thống.

Security Hotspots: Hiển thị số lượng khu vực trong mã cần xem xét bảo mật.

Giúp xác định các khu vực có thể dễ bị tổn thương trong mã để xem xét và giảm thiểu nhằm nâng cao bảo mật.

Maintainability - Debt: Chỉ ra thời gian ước tính (tính bằng ngày) cần thiết cho việc bảo trì mã nguồn trong tương lai.

Nợ kỹ thuật phản ánh gánh nặng bảo trì lâu dài, với giá trị cao hơn cho thấy nhiều khu vực cần cải thiện hơn.

Maintainability - Code Smells: Hiển thị tổng số mùi mã, điều này cản trở khả năng bảo trì mã.

Giảm thiểu mùi mã cải thiện chất lượng mã và dễ dàng bảo trì hơn.

Duplicated Lines: Hiển thị tỷ lệ phần trăm các dòng bị trùng lặp, xác định các khu vực có thể cần tái cấu trúc.

Tỷ lệ trùng lặp thấp hơn giúp dễ dàng bảo trì và cải thiện hiệu quả mã.

Top Contributor of Week: Hiển thị người đóng góp hàng đầu trong tuần dựa trên các cam kết mã.

Tỷ lệ trùng lặp thấp hơn giúp dễ dàng bảo trì và cải thiện hiệu quả mã.

Top Reviewer: Liệt kê các người đánh giá hoạt động nhất theo thứ tự hoạt động. Các đánh giá mã là rất quan trọng để duy trì và cải thiện chất lượng mã; việc làm nổi bật những người đánh giá thường xuyên khuyến khích sự đóng góp vào việc kiểm soát chất lượng.

Top Contributor Over Time: Hiển thị những người đóng góp hàng đầu theo thời gian, giúp theo dõi sự thay đổi trong xu hướng đóng góp.

Theo dõi các đóng góp lâu dài để xác định sự tham gia bền vững và khuyến khích hiệu suất.