Tôi nên làm theo quy tắc StyleCop nào khi viết thư viện nguồn mở

Question

Tôi hiện đang viết trình bao bọc nguồn mở cho đối tượng COM. Tôi vừa cài đặt StyleCop và chạy nó chống lại một số mã của tôi, và như tôi mong đợi nó đã ném lên một tải cảnh báo (một số trong đó tôi nên đã làm đã được ví dụ như thêm "này." Cho tất cả các cuộc gọi phương thức địa phương và các biến)

Tôi nên thử và giảm bao nhiêu cảnh báo này? Cái nào sẽ là cái hay nhất khi viết một thư viện nguồn mở?

Answer 1

Ý tưởng chung với StyleCop là: Tất cả trong số họ :)

Các tùy chọn hơn bạn tắt giá trị StyleCop ít hơn. đã thực thi định dạng mã một đúng. Điều đó đang được nói, nếu bạn không thích một số tùy chọn thì một số tùy chọn tốt hơn không, bao gồm tệp cài đặt StyleCop với mã của bạn và các tùy chọn khác đang hoạt động trên đó có thể sử dụng cùng một cài đặt.

Một số cài đặt có vẻ kỳ lạ lúc đầu nếu bạn không quen với StyleCop, nhưng đã sử dụng nó trong hai năm nay, tôi để lại tất cả các tùy chọn và nhóm của chúng tôi khá hài lòng với kết quả.

Tôi cũng muốn nói rằng nếu bạn đang cung cấp thư viện hoặc khung sử dụng FxCop có thể quan trọng hơn việc sử dụng StyleCop.

Answer 2

Hầu hết các dự án nguồn mở lớn đều có nguyên tắc về phong cách riêng. Ví dụ: đây là số Apache C Language Style Guide.

Bắt đầu, tôi khuyên bạn nên rà soát Câu hỏi thường gặp về dự án OS mà bạn quan tâm và mang nó từ đó.

Dù sao, tôi chắc chắn sẽ có rất nhiều người sẽ nhanh chóng cho bạn biết nếu bạn đang vi phạm bất kỳ quy tắc kiểu hiện tại nào theo một cách lớn! ;-)

Chú ý đến tất cả các cảnh báo, thường họ đang cố gắng cho bạn biết điều gì đó hữu ích. Đừng kết thúc "lập trình bởi trùng hợp ngẫu nhiên" (book excerpt) như các lập trình viên thực dụng nói!

Chỉnh sửa: Tôi không nhận ra rằng đây là dự án hệ điều hành mới, của riêng bạn. Lỗi của tôi. Dù sao, tôi muốn có một sniff xung quanh một số dự án tương tự đã có hệ điều hành hiện có và xem nếu họ có bất kỳ hướng dẫn phong cách. Chắc chắn, hãy kiểm tra cuốn sách Code Complete của Steve McConnell (Amazon link - đã được vệ sinh cho liên kết kiddie script nazis đi lang thang trong các hội trường này).

Điều tôi đã nói về cảnh báo và "lập trình trùng hợp ngẫu nhiên" vẫn được áp dụng! (-:

HTH

cổ vũ,

Rob