Nó sẽ là một ý tưởng tồi để định kỳ chạy các trình định dạng mã trên một kho lưu trữ?

Tôi đang nghĩ đến việc tạo một công việc định kỳ để kiểm tra mã, chạy các trình định dạng mã trên nó và nếu có bất cứ điều gì thay đổi, hãy cam kết các thay đổi và đẩy chúng trở lại.

Hầu hết các dự án sử dụng bộ lọc tự động đặt chúng vào một git hook, nhưng thực hiện nó tự động cứ sau vài giờ sẽ loại bỏ gánh nặng cho mỗi nhà phát triển để cài đặt hook git.

Tôi vẫn sẽ khuyến khích mọi người viết mã sạch, được định dạng tốt và có thể tôi có thể hệ thống tự động ping devs khi mã họ viết được định dạng lại, để họ biết phải làm gì trong tương lai.

Nghe có vẻ hay, nhưng tôi muốn có những người chịu trách nhiệm thực hiện thay đổi mã chứ không phải bot.

Bên cạnh đó, bạn muốn chắc chắn rằng những thay đổi đó không phá vỡ bất cứ điều gì. Ví dụ, chúng ta có một quy tắc sắp xếp các thuộc tính và phương thức theo thứ tự abc. Điều này có thể có tác động đến chức năng , ví dụ như thứ tự dữ liệu và phương thức trong các tệp WSDL của hợp đồng WCF.

Thay vào đó, tôi sẽ cố gắng làm cho mọi người trong nhóm dễ dàng áp dụng định dạng mã tự động theo tiêu chuẩn của nhóm của bạn trực tiếp bên trong trình soạn thảo hoặc IDE của bạn , cho tệp mã nguồn hiện tại (hoặc các phần được chọn của nó). Điều này cho phép các thành viên trong nhóm của bạn kiểm soát nhiều hơn về cách thức và thời điểm định dạng diễn ra, hãy để họ kiểm tra mã trước khi nó được cam kết ở dạng cuối cùng và kiểm tra nó sau khi định dạng diễn ra , không phải trước đó.

Nếu tất cả hoặc hầu hết các thành viên trong nhóm của bạn sử dụng cùng một trình soạn thảo, điều này không quá khó. Nếu mọi người sử dụng một cách khác nhau, thì cách tiếp cận của bạn có thể là giải pháp tốt thứ hai, miễn là nhóm hỗ trợ điều này. Tuy nhiên, tôi khuyên bạn nên cài đặt các biện pháp an toàn bổ sung, như xây dựng hàng đêm và kiểm tra tự động được chạy sau mỗi lần sửa đổi mã tự động.

Đó là một ý tưởng tồi, không chỉ vì nó không khuyến khích mọi người viết mã đàng hoàng, mà còn bởi vì việc định dạng lại sẽ hiển thị khi thay đổi mã trong VCS của bạn (bạn sử dụng một cách tôi hy vọng), che dấu dòng phát triển lịch sử của mã. Thậm chí tệ hơn, mọi hành động định dạng mã (thực sự là mọi thay đổi đối với mã) đều có khả năng đưa ra các lỗi, cho dù đó là thủ công hay tự động. Vì vậy, trình định dạng của bạn bây giờ có thể giới thiệu các lỗi trong mã của bạn mà sẽ không trải qua các đánh giá mã, kiểm tra đơn vị, kiểm tra tích hợp, v.v. cho đến khi có thể vài tháng sau.

Tôi có xu hướng tin rằng đó là một ý tưởng tốt (để tự động chạy các trình định dạng mã), nhưng đó chỉ là ý kiến ​​của tôi.

Tôi sẽ không chạy chúng định kỳ, nhưng nếu có thể trước khi kiểm soát phiên bản cam kết.

Với git , một hook pre-commit làm điều đó sẽ hữu ích. Trong nhiều dự án C hoặc C ++ được xây dựng với một số Makefile , tôi đang thêm một số indentmục tiêu (chạy mã định dạng mã thích hợp như indenthoặc astyle) và mong muốn những người đóng góp chạy make indentthường xuyên. BTW, bạn thậm chí có thể thêm một số makequy tắc để đảm bảo rằng các git hook đã được cài đặt (hoặc để cài đặt chúng).

Nhưng thực sự, nó là một vấn đề xã hội hơn là một vấn đề kỹ thuật . Bạn muốn nhóm của bạn cam kết mã được định dạng rõ ràng và độc đáo, và đó là một quy tắc xã hội của dự án của bạn. (Không phải lúc nào cũng có câu trả lời kỹ thuật cho mọi vấn đề xã hội).

Kiểm soát phiên bản chủ yếu là một số công cụ để giúp liên lạc giữa các nhà phát triển con người (bao gồm cả chính bạn vài tháng kể từ bây giờ). Phần mềm của bạn không cần VC hoặc định dạng, nhưng nhóm của bạn thì có.

BTW, các cộng đồng khác nhau và các ngôn ngữ lập trình khác nhau có quan điểm khác nhau về định dạng mã. Ví dụ, Go chỉ có một kiểu định dạng mã, nhưng C hoặc C ++ có rất nhiều kiểu.

Tôi nghĩ đó là một ý tưởng tồi. Nhiều câu trả lời đã bao hàm rằng nó làm hỏng lịch sử bằng cách gây khó khăn cho việc xác định ai thực sự đã thêm một dòng và nó khuyến khích mọi người chỉ cần cam kết bất cứ điều gì và bot định dạng sẽ xử lý nó.

Một cách tiếp cận tốt hơn sẽ là kết hợp trình kiểm tra định dạng vào công cụ xây dựng của bạn. (Trong Java có Checkstyle ) Sau đó, chỉ cho phép mọi người hợp nhất các nhánh của họ với nhánh chính nếu quá trình xây dựng vượt qua (bao gồm cả định dạng).

Nếu bạn cho phép mọi người cam kết thẳng vào nhánh chính (ví dụ như trong Subversion) thì bạn vẫn cần đảm bảo mọi người đều có kỷ luật chỉ cam kết mã được định dạng (hoặc máy chủ chỉ chấp nhận các cam kết sau khi một số kiểm tra đã được chạy ).

Nói chung, tôi nghĩ đó là một ý tưởng tồi. Về nguyên tắc, đó là một ý tưởng hợp lệ, nhưng nó có thể có vấn đề trong thực tế. Việc trình định dạng mã phá vỡ mã của bạn là một khả năng thực sự và chỉ cần một lần chạy định dạng để các nhà phát triển của bạn phản hồi với sự thù địch (có thể là hợp lý) (ví dụ: "Trình định dạng mã tệ hại của bạn đã phá vỡ bản dựng, hãy tắt ngay bây giờ! " ).

Cũng giống như khuyến nghị của @ BasileStarynkevitch, chúng tôi sử dụng móc nhận sau máy chủ git để gửi "email tư vấn" về kiểu mã.

Nếu tôi đẩy một cam kết có vi phạm kiểu, máy chủ nguồn gốc git sẽ gửi cho tôi một email thông báo cho tôi rằng tôi đã vi phạm các nguyên tắc về kiểu và khuyên tôi nên sửa mã của mình. Tuy nhiên, nó không thực thi điều này bởi vì có thể có những lý do hợp lệ để phá vỡ kiểu nhà (ví dụ, chuỗi dài vượt quá giới hạn chiều dài dòng).

Nếu đó là một vấn đề mang tính hệ thống gây hại cho cơ sở mã, thì có lẽ đã đến lúc bắt đầu đưa ra các vấn đề về kiểu mã trong các đánh giá mã. Kiểu mã kém có thể che giấu các lỗi và làm cho mã khó đọc hơn, do đó nó có thể là một vấn đề xem xét mã hợp lệ.

Để thêm vào khía cạnh "vấn đề xã hội" của mọi thứ, có thể đáng khuyến khích mọi người sửa chữa các khuyết điểm về mỹ phẩm và phong cách khi họ tìm thấy chúng. Chúng tôi có một thông điệp cam kết tiêu chuẩn "Mỹ phẩm." để sửa lỗi kiểu mã mà các nhà phát triển khác biết không chứa các thay đổi vi phạm.

Như @DocBrown nói, một tùy chọn khác là thực thi kiểu mã trong IDE của bạn. Chúng tôi sử dụng CodeMaid với Visual Studio để sửa nhiều lỗi kiểu phổ biến. Nó sẽ chạy khi lưu các tệp mã, có nghĩa là mã kiểu xấu thậm chí không bao giờ được đưa vào repo ... trên lý thuyết :-).

Vâng, tôi nghĩ đó là một ý tưởng tồi. Đừng hiểu sai ý tôi, lý do để làm điều đó nghe có vẻ tuyệt vời, nhưng kết quả vẫn có thể là khủng khiếp.

Bạn sẽ có xung đột hợp nhất khi kéo một nhánh được theo dõi, ít nhất tôi sợ đó là trường hợp, mặc dù tôi có thể sai.

Tôi không muốn kiểm tra nó ngay bây giờ tại nơi làm việc, nhưng bạn nên tự mình thử nó.

Trong thực tế, bạn chỉ có thể kiểm tra một cam kết gần đây. Tạo một chi nhánh mới, cam kết một cái gì đó nhỏ nhặt, chọn anh đào hoặc hợp nhất mà không có tự động.

Sau đó chạy tập lệnh của bạn, kéo và nếu kết quả của bạn là một mớ hỗn độn khủng khiếp, thì bạn chắc chắn không nên làm điều này, vào ban ngày.

Thay vào đó, bạn có khả năng có thể đưa nó vào một bản dựng hàng đêm hoặc một bản dựng hàng tuần.

Nhưng ngay cả một đêm có thể là một ý tưởng tồi.

Bạn có thể chạy nó hàng tuần, khi bạn chắc chắn sẽ không có xung đột hợp nhất nào phát sinh vì mọi thứ đã kết thúc vào thứ hai.

Nếu không thì chạy 1-2 lần một năm vào mùa lễ, khi xung đột hợp nhất sẽ không xảy ra.

Nhưng giải pháp có thể phụ thuộc vào mức độ ưu tiên của bạn đối với kiểu mã.

Tôi nghĩ rằng việc tạo một kịch bản thiết lập tự động tạo kho git và đặt các hook cho dự án sẽ tốt hơn.

Hoặc bạn có thể bao gồm tập lệnh thiết lập hook trong một thư mục cho các nhà phát triển của bạn trong dự án và chỉ cần kiểm tra nó vào git.

Một cái gì đó tôi chưa từng thấy được đề cập là thực tế là đôi khi có những lý do chính đáng để không định dạng một cái gì đó theo một bộ quy tắc. Đôi khi sự rõ ràng của mã được cải thiện bằng cách đi ngược lại một hướng dẫn cụ thể mà 99% thời gian có ý nghĩa. Con người cần thực hiện cuộc gọi đó. Trong những trường hợp đó, định dạng mã tự động sẽ kết thúc làm cho mọi thứ khó đọc hơn.

Đó là một ý tưởng khủng khiếp.

Nếu một trong những đồng nghiệp phát triển của tôi thực hiện các thay đổi miễn phí cho các tệp nguồn, nó sẽ không vượt qua đánh giá mã. Nó chỉ làm cho cuộc sống khó khăn hơn cho tất cả mọi người. Thay đổi mã cần thay đổi, không có gì khác. Thay đổi vô nghĩa dẫn đến xung đột hợp nhất, có thể dẫn đến lỗi và chỉ tạo ra công việc vô nghĩa.

Nếu bạn muốn làm điều này một cách thường xuyên, điều đó thật tồi tệ.

Và sau đó là câu hỏi về loại thay đổi mà trình định dạng mã thực hiện. Tôi sử dụng định dạng tự động trong trình chỉnh sửa của mình, nó hoạt động khá tốt và tôi có thể cải thiện mọi thứ khi định dạng tự động kém hoàn hảo. Nếu bạn sử dụng một trình định dạng mã vượt xa điều đó, bạn sẽ không cải thiện mã, bạn sẽ làm cho nó tồi tệ hơn.

Và sau đó là vấn đề xã hội. Có những người muốn buộc mọi người sử dụng kiểu mã của họ, và có những người linh hoạt hơn. Một cái gì đó như thế này có thể sẽ được đề xuất bởi loại nhà phát triển "grammer-nazi" (đánh vần có chủ đích), những người muốn áp đặt phong cách của họ lên mọi người khác. Mong đợi một phản ứng dữ dội, và mong đợi các nhà phát triển linh hoạt, thường dễ dàng đặt chân xuống.

Bạn không đề cập đến VCS bạn sử dụng nhưng tùy thuộc vào tùy chọn khác là có một móc phía máy chủ. Một VCS như git hỗ trợ điều đó. Bạn có thể cài đặt một hook phía sever chạy bộ định dạng trên phiên bản đang được đẩy và sau đó so sánh tệp được định dạng với phiên bản đang được đẩy. Nếu chúng khác nhau, nhà phát triển đã không sử dụng định dạng chính xác và máy chủ có thể từ chối việc đẩy. Điều này sẽ buộc các nhà phát triển của bạn chỉ đẩy mã với định dạng mong muốn, do đó khuyến khích họ viết mã sạch ngay từ đầu, điều đó sẽ khiến các nhà phát triển chịu trách nhiệm kiểm tra mã được định dạng chính xác và giúp các nhà phát triển của bạn khỏi phải cài đặt thủ công móc.

Đó là sự đánh đổi giữa một định dạng mã sạch hơn và chính xác hơn và dễ hiểu hơn về lịch sử git. Phụ thuộc vào bản chất của dự án của bạn và tần suất bạn lặn trong lịch sử git hoặc đổ lỗi để hiểu những gì đang xảy ra. Nếu bạn đang làm việc trên một cái gì đó mới và không phải duy trì khả năng tương thích ngược, lịch sử thường không đóng vai trò quan trọng.

Ý tưởng này tương tự như một số câu trả lời khác, nhưng tôi không thể nhận xét đề xuất của mình.

Một tùy chọn là đặt bí danh (hoặc hook hoặc bất cứ thứ gì) cho hàm commit, chạy bộ định dạng mã trên mã được cam kết trước khi nó được cam kết.

Nó có thể có 2 (hoặc nhiều hơn) kết quả:

1) Hiển thị cho người dùng các thay đổi được đề xuất và yêu cầu phê duyệt để áp dụng và cam kết các thay đổi.

2) Bỏ qua các thay đổi được đề xuất và cam kết mã gốc.

Bạn cũng có thể thêm linh hoạt hơn cho các tùy chọn này, như khả năng chỉnh sửa các thay đổi được đề xuất trong tùy chọn 1. Một ý tưởng khác (Tùy thuộc vào mức độ bạn muốn đẩy các tiêu chuẩn mã hóa này) là để hệ thống gửi cho bạn một báo cáo nào đó khi tùy chọn 2 được chọn.

Đây có thể là một sự cân bằng tốt của việc tự động kiểm tra tất cả các mã như bạn muốn, trong khi vẫn cho phép linh hoạt cho các nhà phát triển phù hợp với nhu cầu của họ. Nó cũng cho phép tùy chọn không 'tự động từ chối' mã với các khác biệt về định dạng như được đề cập trong các câu trả lời khác. Với 'Tôi đã xem xét và phê duyệt chỉnh sửa định dạng tự động; tùy chọn cam kết, nó vẫn giữ trách nhiệm cá nhân cho mỗi nhà phát triển hoạt động và không gây rối với VCS.

Tôi sẽ không làm điều đó trên kho lưu trữ nhưng tôi sẽ lưu nó nếu công cụ hỗ trợ. Eclipse là một và ngoài ra tôi sẽ làm sạch mã bao gồm cả sắp xếp.

Phần hay là nó là một phần của dự án nên mọi nhà phát triển sẽ lấy nó cho dự án của họ.

Vì một sự hợp nhất tiền thưởng bổ sung sẽ được đơn giản hóa đáng kể vì mọi thứ sẽ không được nhảy xung quanh.

Mã đánh giá sẽ ngăn chặn bất kỳ những người sai lầm.

Một nơi khác tôi sẽ làm nó là một phần của bản dựng. Trong trường hợp của tôi, tôi có các bản dựng maven sẽ định dạng lại XML và dọn sạch các tệp pom và định dạng lại mã.

Theo cách đó, khi các nhà phát triển sẵn sàng đẩy nó, tất cả sẽ được dọn sạch cho yêu cầu kéo của họ.