Làm thế nào để đảm bảo chất lượng và khả năng bảo trì mã nguồn với các công cụ phân tích Roslyn?

Hình ảnh phía trên được trích từ một video minh họa cách sử dụng điển hình của trình phân tích Roslyn. Trong ví dụ này, việc phân tích mã nguồn đã phát hiện ra một biến không được sử dụng. Nhà phát triển được thông báo về vấn đề này vì biến count được gạch chân bằng một đường lượn sóng màu xanh lá cây. Nhấp vào đó sẽ hiển thị vấn đề và một liên kết chứa các tùy chọn để khắc phục. Trong video, nhà phát triển đã chọn xóa biến không sử dụng dựa trên khuyến nghị.

Ngoài đường lượn sóng màu xanh lá cây, bạn cũng có thể thấy đường lượn sóng màu đỏ hoặc các chấm màu xám. Các ký hiệu khác nhau này biểu thị mức độ bảo mật của vấn đề, hay mức độ nghiêm trọng của sự cố đối với mã nguồn của bạn.

Như bảng trên cho thấy, mỗi bộ phân tích đều có mức độ nghiêm trọng do người dùng cấu hình.

Có một số công cụ phân tích Roslyn khác nhau, nhưng Visual Studio cũng đã cài đặt sẵn một số công cụ. Bạn có thể điều chỉnh cài đặt của các bộ phân tích tích hợp này ở hai vị trí. Đối với phiên bản Visual Studio cục bộ của bạn, các cài đặt mặc định được điều chỉnh thông qua Công cụ > Tùy chọn > Trình soạn thảo văn bản > C# > Kiểu mã > Chung . Bạn có thể thay đổi mức độ nghiêm trọng bằng cách sử dụng hộp thoại hiển thị trong hình ảnh phía trên.

Hình ảnh trên là một lớp mã đơn giản. Dấu chấm lửng (ba dấu chấm thẳng hàng) dưới các chữ cái p và o trong từ pos ở dòng 7 và câu lệnh if ở dòng 11 biểu thị một gợi ý. Đường lượn sóng màu xanh lá cây bên dưới khoảng cách là cảnh báo, còn đường lượn sóng màu đỏ bên dưới hai lần xuất hiện của xPos trên dòng 11 là lỗi. Các cảnh báo và lỗi cũng sẽ xuất hiện trong cửa sổ Danh sách lỗi.

Bạn sẽ nhận thấy rằng hình ảnh hiển thị cài đặt cho các trình phân tích tích hợp sẵn sẽ chuyển đổi giữa chế độ Chỉ tái cấu trúc và đề xuất cho Tùy chọn khối mã: Tôi thích niềng răng hơn. . Việc tái cấu trúc mã chỉ đơn thuần là ẩn dấu ba chấm dưới câu lệnh if.

Nếu tùy chọn "Ưu tiên dấu ngoặc" là gợi ý và bạn di chuột qua dấu ba chấm, bạn sẽ thấy một bảng hiển thị liên kết đến các giải pháp khả thi . Nhấp vào đây sẽ hiển thị một bảng khác với các tùy chọn có sẵn. Trong trường hợp này, chỉ có một lựa chọn duy nhất, đó là thêm dấu ngoặc nhọn vào mã. Hình ảnh phía trên minh họa trình tự này.

Nếu bạn muốn đảm bảo tuân thủ quy tắc viết mã cho một dự án cụ thể, bạn có thể thêm tệp .editorconfig đi kèm với dự án đó. Đây có thể là một cách hiệu quả để thực thi các quy tắc về phong cách viết mã đã được thống nhất trong một nhóm lớn gồm nhiều nhà phát triển.

Tệp .editconfig cho phép bạn ghi đè các cài đặt trong phiên bản Visual Studio của mình thông qua Công cụ > Tùy chọn > Trình soạn thảo văn bản > C# . Bạn thậm chí có thể lồng nhiều tệp .editorconfig nếu cần bằng cách đặt một tệp ở thư mục gốc và một tệp trong thư mục con. Tệp trong thư mục con sẽ ghi đè lên tệp ở thư mục gốc.

Các phần tiếp theo sẽ hướng dẫn cách thêm tệp .editorconfig.

Thay đổi mức độ nghiêm trọng của bộ phân tích được bao gồm trong cửa sổ văn bản mã.

Nhấp chuột phải vào Solution Explorer và chọn New Item. Trong cửa sổ tiếp theo, chọn Installed > C# > General editorconfig File (default) .

Một lựa chọn khác là chọn Generate .editorconfig file từ phần cài đặt trong Tools > Options > Text Editor > C# (như trong hình ảnh bên dưới Configure built-in analyzers).

Giờ đây, khi bạn đã có tệp .editorconfig, Visual Studio (phiên bản Windows ) sẽ hiển thị một chế độ xem có thể chỉnh sửa của tệp văn bản đó ở bên trong hệ thống. Các thay đổi đối với tệp này sẽ ảnh hưởng đến các tập lệnh C# trong thư mục nơi tệp .editorconfig được lưu và bất kỳ thư mục con nào của nó.

Bạn có thể mở rộng chức năng bằng cách bổ sung thêm các trình phân tích Roslyn đã được cài đặt sẵn. Các công cụ phân tích được cài đặt dưới dạng gói NuGet hoặc tiện ích mở rộng Visual Studio (tệp VSIX). Hãy truy cập www.nuget.org để tìm hiểu quy trình cài đặt gói NuGet. Một công cụ phổ biến là StyleCop.Analyzers, dùng để tìm kiếm các vấn đề về kiểu dáng trong mã nguồn của bạn.

Cài đặt gói trong Visual Studio bằng Trình quản lý gói thông qua Công cụ > Trình quản lý gói NuGet > Trình quản lý gói . Trang www.nuget.org của mỗi gói phân tích sẽ hiển thị lệnh cần dán vào Package Manager Console. Thậm chí còn có một nút tiện dụng để sao chép văn bản vào clipboard.

Các cụm phân tích đã được cài đặt và xuất hiện trong Solution Explorer dưới mục References > Analyzers .

Một lựa chọn khác là cài đặt các trình phân tích được cung cấp dưới dạng tiện ích mở rộng VSIX. Trong Visual Studio, chọn Tiện ích mở rộng > Quản lý tiện ích mở rộng .

Nếu bạn biết tên của tiện ích mở rộng, hãy sử dụng trường tìm kiếm để tìm nó hoặc đơn giản là tìm kiếm từ khóa “analyzer”. Hình ảnh trên cho thấy công cụ Phân tích Bình luận đã được chọn. Nhấp vào Tải xuống để cài đặt tiện ích mở rộng trình phân tích, chọn OK để đóng hộp thoại và đóng tất cả các phiên bản Visual Studio để khởi chạy Trình cài đặt VSIX.

Chọn Chỉnh sửa để bắt đầu cài đặt. Sau khi quá trình cài đặt hoàn tất, hãy chọn Đóng và mở lại Visual Studio.

Nếu bạn muốn kiểm tra xem tiện ích mở rộng đã được cài đặt hay chưa, hãy chọn Tiện ích mở rộng > Quản lý tiện ích mở rộng . Trong hộp thoại Quản lý tiện ích mở rộng, chọn danh mục Đã cài đặt ở bên trái, sau đó tìm kiếm tiện ích mở rộng theo tên.

Bài viết này tập trung vào các trình phân tích Roslyn tích hợp sẵn trong Visual Studio, nhưng bạn cũng có thể tự xây dựng trình phân tích của riêng mình. Các công cụ phân tích được xây dựng bằng nền tảng trình biên dịch .NET có thể cải thiện đáng kể chất lượng mã của nhóm bạn.

Khi bạn đã có kinh nghiệm trong việc tạo các công cụ phân tích, bạn sẽ nhận thấy chúng giúp nhóm của bạn làm việc hiệu quả hơn trong việc giải quyết các vấn đề về lập trình như cú pháp, chỉnh sửa lặp đi lặp lại, hướng dẫn sử dụng thư viện mới, v.v.

Một vài nguồn tài liệu bổ sung hữu ích khác từ Microsoft bao gồm hướng dẫn này về cách tạo trình phân tích Roslyn C# của riêng bạn và video trên YouTube này về trình phân tích Roslyn.

Gỡ lỗi trong Unity

Hãy tham khảo thêm các mẹo gỡ lỗi dự án Unity của bạn từ các bài viết sau:

• Microsoft Visual Studio 2022
• Microsoft Visual Studio Code

Sách điện tử kỹ thuật nâng cao

Unity cung cấp một số hướng dẫn nâng cao để giúp các nhà phát triển chuyên nghiệp tối ưu hóa mã trò chơi. Tạo một hướng dẫn về phong cách lập trình C#: Viết mã sạch hơn, có khả năng mở rộng. Tổng hợp các lời khuyên từ các chuyên gia trong ngành về cách tạo hướng dẫn phong cách mã hóa để giúp nhóm của bạn phát triển một codebase sạch sẽ, dễ đọc và có khả năng mở rộng.

Một hướng dẫn phổ biến khác với người dùng của chúng tôi là hơn 70 mẹo để tăng năng suất khi sử Unity . Nó chứa đầy những mẹo tiết kiệm thời gian để cải thiện quy trình làm việc tổng hợp hàng ngày của bạn với Unity 2020 LTS – những mẹo mà ngay cả các nhà phát triển giàu kinh nghiệm cũng có thể đã bỏ sót.

Bạn có thể tìm thấy tất cả các sách điện tử và bài viết nâng cao của Unity tại trung tâm hướng dẫn thực hành tốt nhất Unity .