Tôi là một người ủng hộ bình luận về mã nguồn và tài liệu sản phẩm phần mềm. Đó là kinh nghiệm cá nhân và quan sát của tôi rằng làm việc với mã nguồn được nhận xét nghiêm ngặt đã giúp tôi theo những cách khác nhau khi tôi phải phát triển phần mềm hoặc bảo trì nó.
Tuy nhiên, có một trại khác nói rằng bình luận cuối cùng là vô giá trị hoặc giá trị của nó là nghi vấn. Nhiều người đề xuất mã hóa mà không bình luận cho rằng:
- Nếu một đoạn mã được viết tốt, nó sẽ tự giải thích và do đó không cần bình luận
- Nếu một đoạn mã không tự giải thích, thì hãy cấu trúc lại nó và làm cho nó tự giải thích để nó không cần bất kỳ bình luận nào
- Bộ kiểm tra của bạn là tài liệu trực tiếp của bạn
- Theo thời gian mã và nhận xét không đồng bộ và nó trở thành một nguồn đau đầu khác
- Agile nói rằng mã làm việc quan trọng hơn đống tài liệu, vì vậy chúng ta có thể bỏ qua việc viết bình luận một cách an toàn
Đối với tôi đây chỉ là giáo điều. Một lần nữa, quan sát cá nhân của tôi là phần mềm được viết bởi các nhóm các nhà phát triển thông minh và có kinh nghiệm cuối cùng kết thúc với một số lượng đáng kể mã không tự giải thích được.
Một lần nữa, API Java, API ca cao, API Android, v.v. cho thấy rằng nếu bạn muốn viết và duy trì tài liệu chất lượng, điều đó là có thể.
Đã nói tất cả những điều này, các cuộc trò chuyện về ưu và nhược điểm của tài liệu và nhận xét về mã nguồn dựa trên niềm tin cá nhân thường không kết thúc tốt và dẫn đến không có kết luận thỏa mãn.
Vì vậy, tôi đang tìm kiếm các bài báo học thuật và nghiên cứu thực nghiệm về tác động của tài liệu phần mềm, đặc biệt là nhận xét mã nguồn, về chất lượng và khả năng bảo trì cũng như ảnh hưởng của nó đến năng suất của nhóm.
Bạn có vấp phải những bài báo như vậy không và kết quả của chúng là gì, nếu có?