2012-01-10 7 views
9

Tôi đang cố gắng tìm danh sách tất cả các định dạng và quy tắc mặc định mà Resharper thực thi.Danh sách Thu hồi lại Định dạng và Quy tắc Mặc định

Thật không may, tôi không có may mắn.

Chúng tôi sử dụng công cụ này, nhưng muốn cung cấp tài liệu tiêu chuẩn cho người mới thuê để họ có thể xem các tiêu chuẩn trước khi mã hóa.

+2

Imho điều này là rất cần thiết. Chỉ vì nó là nhàm chán không có nghĩa là nó là không hợp lý.Có thể nói, không phải vì bạn chỉ cần xem qua các thiết lập quy tắc, tuy nhiên hầu hết các cửa hàng lớn yêu cầu tài liệu và thảo luận về "mặc định" là gì và "quy tắc này phù hợp với SDLC như được định nghĩa bởi tổ chức của tôi" –

Trả lời

7

Trong trình đơn ReSharper, sau đó chọn Tùy chọn, bạn sẽ thấy các quy tắc và quy ước hiện tại mà ReSharper đang sử dụng cho giải pháp này. Đặc biệt quan trọng là:

Kiểm tra mã-> Kiểm tra Mức độ nghiêm trọng: Cho biết mức độ nghiêm trọng của những thứ mà ReSharper phát hiện trong mã. Càng nhiều cảnh báo hoặc lỗi, bạn càng phải tuân theo quy tắc của ReSharper để có được tệp "chuyển sang màu xanh" hoặc thậm chí là biên dịch. Các hệ thống phân cấp là:

  • Không hiển thị - tự giải thích, bỏ qua việc kiểm tra
  • Gợi ý - Không hiển thị trên thanh bên, cho thấy dòng như rải rác dưới mã trong câu hỏi. Ví dụ tốt: sử dụng "var" khi dòng mã không chỉ định rõ ràng loại được chỉ định.
  • Đề xuất - Hiển thị trên thanh bên dưới dạng đánh dấu màu xanh lá cây, mã được đề cập có đường gạch dưới màu xanh lá cây. Ví dụ hay: sử dụng "var" khi loại được xác định rõ ràng trong nhiệm vụ, khả năng hiển thị thành viên.
  • Cảnh báo - Hiển thị trên thanh bên là dấu màu vàng, mã được đề cập màu xanh lam gạch dưới hoặc văn bản bị mờ màu. Đặt tên vi phạm quy ước, từ khóa thừa hoặc vòng loại, thành viên mã không sử dụng.
  • Lỗi - Đánh dấu chọn thanh bên màu đỏ, mã được đề cập đến văn bản màu đỏ hoặc màu đỏ được gạch chân. Theo mặc định, không có gì không gây ra lỗi biên dịch được đánh dấu là lỗi ReSharper, nhưng bạn có thể ngăn việc biên dịch bằng cách "kiểm tra" các kiểm tra ưu tiên thấp hơn cho các lỗi.

Ngôn ngữ-> Kiểu đặt tên: Phần này cho bạn biết cách ReSharper mong đợi các loại tên thành viên mã khác nhau được định dạng. Tùy chọn "Cài đặt nâng cao" cũng chứa "danh sách viết tắt", về cơ bản là danh sách các ngoại lệ đối với các quy ước vỏ lạc đà bình thường. Theo mặc định, tất cả các mâu thuẫn định dạng đều là cảnh báo và tôi không thấy cách nào trong phiên bản 5.1 (phiên bản tôi sử dụng) để thay đổi mức độ nghiêm trọng của việc này.

EDIT: Đây là danh sách kiểm tra và mức độ nghiêm trọng mặc định của chúng đối với RS 4.5, đây là một vài phiên bản nhưng vẫn phải có "thịt" của kiểm tra C# của ReSharper. http://unintelligible.org/blog/2010/05/24/resharper-45-inspection-severity-list/

Ngoài điều này, ngay cả JetBrains chỉ đơn giản là giới thiệu bạn đến cửa sổ Tùy chọn nếu bạn muốn xem danh sách kiểm tra ngôn ngữ hiện tại của mình. Vì vậy, nếu bạn muốn một cái gì đó cập nhật hơn, bạn có thể phải tự mình làm điều đó. Nếu bạn làm, hãy chắc chắn để đăng nó một nơi nào đó để những người khác không phải lặp lại công việc của bạn.

+0

Nhưng có danh sách nào đó ở tất cả các giá trị mặc định không? Thay vì tôi sao chép tất cả thông tin đó vào tài liệu từ cài đặt? – CaffGeek

+0

Tôi đang tìm kiếm. Nếu có một vị trí liệt kê tất cả các giá trị mặc định tôi mong đợi nó nằm trên trang JetBrains, nhưng tài liệu dường như không có bất kỳ điều gì rõ ràng. – KeithS

+0

đó là những gì tôi đã tìm thấy quá – CaffGeek

1

Chuẩn mã hóa công ty IMHO không chỉ là định dạng. Nó thường bao gồm các quy ước tổ chức dự án, hướng dẫn sử dụng thư viện, vv Liệt kê mọi quy tắc định dạng có thể có mà ReSharper biết sẽ làm cho nó khá dài và nhàm chán. Một vài ví dụ cho các cấu trúc chung (mà bạn có thể sao chép từ phần dưới cùng của cửa sổ thiết lập định dạng) là đủ. Cung cấp cho họ với lý do ngắn không nên quá khó để làm bằng tay.

+0

Tôi đồng ý, nhưng đó không phải là cuộc gọi của tôi. – CaffGeek