Tôi có nên thay đổi tên tác giả trong tệp lớp nếu tôi thực hiện thay đổi hơn 80% không?

Tôi đang cấu trúc lại tập hợp các lớp kiểm tra java hiện có để kiểm tra giao diện người dùng tự động. Đôi khi tôi kết thúc việc thực hiện các thay đổi lớn trong tệp lớp hoặc hoàn toàn sửa đổi nó. Điều này khiến tôi nghĩ rằng khi tôi viết lại toàn bộ lớp thì tôi có nên đổi tên tác giả trong phần bình luận thành của tôi không?

Tôi có tham lam không? hoặc nó sẽ hữu ích cho một người để xem tên của tôi và hỏi tôi trong trường hợp nghi ngờ?

Nó thực sự phụ thuộc ...

Nếu bạn nghĩ rằng có một cơ hội nhỏ mà người khác có thể quan tâm sau đó khi hỏi tác giả ban đầu, hãy để tên của anh ấy trong mã. Nếu bạn nghĩ rằng ai đó có thể quan tâm đến việc hỏi bạn trực tiếp, hãy để tên của bạn trong đó. Và nếu bạn nghĩ, cả hai có thể đều có thể, hãy để cả hai tên trong (hoặc một nhận xét như "dựa trên công việc của ...).

Tất nhiên, khi việc sử dụng kiểm soát nguồn là bắt buộc tại nơi làm việc của bạn và đó là cách duy nhất để có quyền truy cập vào các nguồn, sau đó lưu hussle và loại bỏ mọi bình luận của tác giả ra khỏi nguồn. Ví dụ, tại nơi làm việc của tôi, chúng tôi có rất nhiều tệp nguồn trong kiểm soát nguồn mà chúng tôi không bận tâm viết bất kỳ tên nào vào nguồn. Nếu tôi muốn biết ai chịu trách nhiệm về tệp, hoặc trong quá khứ hoặc cho một thay đổi cụ thể, TortoiseSVN sẽ dễ dàng tạo cho tôi nhật ký cho việc đó.

Mặt khác, chúng tôi có rất nhiều macro VBA, được viết bởi một số kẻ, được chuyển cho những người khác (một số trong số họ rời công ty trong nhiều năm) và đã được sửa đổi rất nhiều, tất cả đều không sử dụng kiểm soát nguồn. May mắn thay, bình luận của những tập tin đó thường chứa tên tác giả và một số loại nhật ký lịch sử.

Tôi vừa bắt gặp một bài đăng khác, nơi OP đang hỏi liệu tên tác giả có nên nằm trong tiêu đề tệp hay không và dường như ít nhất 2/3 số người trả lời đã nói rằng tên đó thậm chí không được liệt kê và bạn nên sử dụng kiểm soát phiên bản để chỉ cần theo dõi những người đã thay đổi tập tin. Không biết những gì đã xảy ra với bài viết đó, nhưng bây giờ tôi không thể tìm thấy nó. <- (do đó ẩn danh "OP")

Cá nhân, tôi thấy tác giả được liệt kê trong tiêu đề tệp là hữu ích nhưng vì một lý do hơi khác (và điều này có thể không liên quan đến những người khác trong môi trường của họ). Mặc dù chúng tôi cố gắng thực hành quyền sở hữu cộng đồng và thường làm việc trên các phần khác nhau của dự án, chúng tôi có xu hướng có ít thành viên trong nhóm biết một số khu vực nhất định của mã hơn nhiều so với các phần khác. Vì vậy, khi ai đó (đặc biệt là nhiều nhà thầu đến và đi) mở một tệp mà họ chưa từng thấy trước đây, tác giả sẽ trở thành người trực tiếp. Anh ta có thể không phải là người đóng góp duy nhất, hoặc thậm chí là người đóng góp đa số, nhưng có tên của anh ta ở đầu, anh ta thừa nhận có trách nhiệm nhất định trong việc phân phối kiến ​​thức / thông tin về mã cho các thành viên còn lại trong nhóm. Chúng tôi có thể liệt kê nhiều hơn một người trong tiêu đề là nhiều người thực sự đã đóng góp và cảm thấy có trách nhiệm.

Tôi thấy khó chịu khi tôi có một câu hỏi về một tập tin và phải dùng đến kiểm soát phiên bản để xác định người chính hoặc người hiểu biết nhất. Sau đó, cuối cùng đi từ một anh chàng sang người tiếp theo vì tất cả họ đều phủ nhận thực sự biết mã làm gì ... họ chỉ cần đi vào và sửa một hoặc hai lỗi.

Thực hành này hoạt động trong nhóm của chúng tôi bởi vì chúng tôi không có sự giúp đỡ. Trừ khi một người rời khỏi, hoặc chuyển sang một nhóm khác, mã / dự án đó sẽ ở lại với người đó và với nhóm của chúng tôi. Rõ ràng nếu những người duy trì mã không giống như những người viết nó, thì không ai quan tâm ai được liệt kê trong tiêu đề.

Vì vậy, theo quan điểm của tôi về tiêu đề tệp, tôi sẽ nói nếu bạn thay đổi 80% tệp và bạn cảm thấy như bây giờ bạn là người thích hợp cho bất kỳ câu hỏi nào (và có lẽ bạn nên cảm thấy như vậy), vâng, đi phía trước và cập nhật tiêu đề tập tin để có tên của bạn trên đó. Nếu bạn cảm thấy tồi tệ về việc loại bỏ người trước đó, bạn cũng có thể để tên của họ ở đó, ít nhất là trong thời điểm hiện tại. Bạn luôn có thể hỏi tác giả gốc và tôi chắc chắn họ sẽ không bận tâm một chút rằng bạn đã thay đổi tên, vì tôi cho rằng không có cảm giác khó khăn nào về việc bạn tự thay đổi 80% tệp.

CẬP NHẬT: Tìm thấy bài viết đó . Không biết làm thế nào tôi quản lý để kéo một cái gì đó trở lại từ tháng Tám. Tôi vừa đọc xong Lập trình viên thực dụng và trong chương cuối, các tác giả đã nói về việc ký kết công việc và trách nhiệm giải trình (bài đăng khác đã đề cập đến nó, đó là lý do tại sao tôi tìm kiếm nó). Cuốn sách có ý nghĩa hoàn hảo và bây giờ tôi nghĩ về nó, có lẽ chúng ta nên đưa ra chính sách nhóm rằng bất kỳ ai được liệt kê là tác giả, nên được đưa vào tất cả các đánh giá mã của tệp được đề cập. Không quan trọng ai đã thay đổi tệp cuối cùng hoặc nhiều nhất trong SVN, tác giả là chủ sở hữu và là người giữ.

Tôi không tìm thấy tên của tác giả cực kỳ hữu ích. Như câu hỏi này cho thấy, thường không có tác giả duy nhất, vì vậy việc đặt tên "tác giả" là không thể.

Tất nhiên bạn có thể bao gồm một danh sách tất cả những người có đóng góp lớn, nhưng bạn đã có thể nhận được điều đó từ nhật ký kiểm soát sửa đổi - vậy vấn đề là gì?

Trong dự án của tôi, không có thông tin tác giả trong hầu hết các tập tin. Nếu bạn có một câu hỏi, bạn chỉ cần nhìn vào nhật ký, và thường thì rõ ràng là một hoặc hai người đã làm hầu hết công việc, vì vậy bạn hỏi họ.

Biên tập

Câu trả lời giả định một dự án sử dụng kiểm soát phiên bản. Nếu bạn không (nhất quán) sử dụng VC, sau đó đặt một tác giả (danh sách) và có thể một số lịch sử thay đổi vào một tệp có thể là một cách giải quyết khả thi. Tuy nhiên, có lẽ bạn nên bắt đầu sử dụng VC càng nhanh càng tốt, trong trường hợp này, hãy xem ở trên :-).

Nếu tệp đã được sửa đổi đáng kể, bạn có thể chấp nhận thêm tên của mình vào tệp như một người biết điều gì đó về nó.

Người tạo tệp nguồn nên / phải luôn luôn (IMHO) được đề cập trong tệp nguồn. Điều này, với nhận xét tiêu đề tốt, sẽ cho thấy lý do tại sao tác giả phát triển nguồn và suy nghĩ của anh ấy / cô ấy là gì để viết mã. Đối với người duy trì mã, việc thêm tên của người bảo trì là rất quan trọng để theo dõi kiểm soát nguồn.

Việc đặt tên tác giả, IMHO một lần nữa, nên bao gồm phiên bản nguồn của mã, bên ngoài hệ thống kiểm soát phiên bản, ngày đầu tiên khi thay đổi xảy ra, cũng như số yêu cầu thay đổi. Lý do là, nếu quyết định thay đổi VCS phát sinh, có lịch sử của phiên bản mã, ai là tác giả cũng như số yêu cầu thay đổi mà các nhà phát triển có thể tham khảo (nếu họ cần biết tại sao người bảo trì lại làm những gì anh ta / cô ấy đã làm). Do đó, trong tổ chức của chúng tôi, định dạng của chúng tôi như sau:

/**
 * $comment
 * <p />
 * $cr_number, $date, $author, $description 
 **/

Tôi thích nhìn thấy tên tác giả ban đầu, nếu chỉ để tìm ai đó bắt đầu hành trình tìm kiếm câu trả lời của tôi về mã. (Tác giả thường không có hồi ức, nhưng ít nhất đó là một phát súng!)

Tôi khuyên bạn chỉ cần thêm tên của bạn bên dưới tên tác giả ban đầu.

Không cần thay thế tên của người khác, vì họ có thể biết một số khía cạnh của nhu cầu kinh doanh ban đầu mà bạn không có, và những người khác theo sau bạn cũng có thể cần nói chuyện với người đó.

Chính sách của tôi về ý kiến ​​@ Tác giả là:

1. Nếu đó là một tập tin hoàn toàn mới, tôi đặt mình là @ Tác giả.
2. Nếu đó là một tệp hiện có, tôi để @ tác giả một mình, bất kể tôi làm gì với tệp đó.

Nếu bạn có câu hỏi về vấn đề gì đó, không quan trọng ai là @ Tác giả của tệp - vấn đề là ai là tác giả của phần nào của tệp bạn đang chỉnh sửa. Đó là những gì [git/svn/whatever] blamedành cho.

IMO, @ Tác giả cần phải đi xa.