Tôi không biết về các môi trường khác nhưng khi nói đến các dự án PHP lớn (thường là nguồn mở) mà người khác đã viết, phpXRef là một trình bảo vệ cuộc sống tuyệt đối (đặc biệt là nếu tài liệu được đặt trực tuyến và Google có thể lập chỉ mục cho nó).
Ngay cả một dự án được bình luận xấu ít nhất cũng có thể giúp tôi theo dõi nơi mọi thứ đã được xác định và nơi chúng được sử dụng (ví dụ khi tái cấu trúc).
Khi được bình luận tốt, các trang kết quả hình thành gần với một cuốn Kinh thánh hoàn hảo cho codebase (dù sao tôi cũng sử dụng).
Hơn nữa, IDE ưa thích của tôi sẽ tự động tạo khối nhận xét (nếu tôi nhập / **), công việc này chiếm khoảng 75% công việc bình luận cho tôi. Thật đáng kinh ngạc khi có bao nhiêu điều ngu ngốc mà tôi đã dừng lại trong suốt cuộc đời lập trình viên của mình chỉ vì tôi phải giải thích cho những người khác (và cả tôi trong tương lai) những gì tôi đang làm. Khi nhận xét của tôi về trình tạo tài liệu lớn hơn phương thức, điều này thường có nghĩa là tôi chưa uống đủ cà phê và có thể muốn suy nghĩ kỹ hơn một chút.
Các khối nhận xét giống nhau đó cũng tạo ra văn bản "trợ giúp" hoàn thành nội tuyến để tôi có thể thấy chính xác những gì được mong đợi (bởi các lập trình viên khác) khi tôi đang viết lệnh gọi hàm. Đây là một sự tăng năng suất lớn đối với tôi (đặc biệt là trong những trường hợp hiếm hoi mà một số nhà phát triển hữu ích khác đã viết "vì lợi ích không làm / không làm X" - có thể tiết kiệm rất nhiều nỗi đau.
Tôi không thể nhấn mạnh đủ mức độ hữu ích của các loại đầu vào dự kiến được chỉ định trong các dự án PHP phức tạp (và thường được đặt tên xấu) và thứ tự đối số trong các phương thức ít được sử dụng. Ngay cả với mã của riêng tôi, tôi không thể luôn nhớ những đối số tôi đã chỉ định cho điều gì đó mà tôi chưa từng chạm vào trong thời đại.
Trong một trường hợp, điều đó có nghĩa là nguồn gốc của các vấn đề tái diễn là vì một số lý do phản ánh không tốt đối với các nhà phát triển trước đó, một số hàm và thậm chí các hằng số đã được xác định ở một số lượng lớn (với mức độ không nhất quán để thêm "niềm vui") . Đó là dấu hiệu để đi từ dự án.
Trong các dự án lớn hơn bắt đầu trước khi tôi tham gia, tôi có thể thấy nhà phát triển nào (giả sử họ đã gắn thẻ tệp lớp với tên và email) đã tạo lớp và chỉ cần có thể tìm và nói chuyện với nhà phát triển phù hợp là vô cùng hữu ích.
Danh sách tác vụ tự động - sử dụng thẻ @todo (phổ biến trong loại dự án tôi thấy mình đang làm việc) có nghĩa là tài liệu có thể theo dõi những thứ cần thêm một số công việc (hoặc các tính năng được thừa nhận là thiếu). Một lần nữa, IDE của tôi theo dõi điều này và một mình đóng vai trò là một hướng dẫn tốt về những gì cần sự chú ý của tôi trước tiên.
Cuối cùng (và rất quan trọng đối với tôi), nó loại bỏ chi phí không hề nhỏ trong việc viết ra tất cả những điều đó và sau đó cố gắng cập nhật khi một số (đọc nhiều) lập trình viên cam kết thay đổi và không nói chuyện với những người duy trì tài liệu.
Vì vậy, lý do bao gồm:
- Tiết kiệm cho các nhà phát triển sau này một đống thời gian,
- Theo dõi nơi các chức năng được gọi (và được xác định),
- Phát hiện mã hóa ngớ ngẩn,
- Tìm kiếm (như người khác đã chỉ ra) khi thiếu thứ gì đó rõ ràng,
- Đơn giản hóa tái cấu trúc (không bao giờ nhiều niềm vui)
- (Trong nhiều trường hợp) nhận được ý tưởng về những gì nhà phát triển đã cố gắng thực hiện (giả sử anh ta hoặc cô ta để lại một số ghi chú).
- Nếu dự án đủ phức tạp để có nhiều giấy phép đang diễn ra (không vui) tôi có thể nhanh chóng xem giấy phép nào áp dụng cho bất kỳ phần nào. Phải thừa nhận rằng đây là phần thưởng phụ.
- Lấy ý tưởng về người để nói chuyện về một tệp dự án.
- Danh sách nhiệm vụ tự động
Ngoài ra, đừng đánh giá thấp giá trị của việc giữ cho những ông chủ tóc nhọn vui vẻ khi chạm vào nút.
Nói tóm lại, "bình luận tài liệu tự động" rất quan trọng đối với thói quen mã hóa của tôi. Tôi chắc chắn có nhiều người nghĩ rằng đó là khập khiễng nhưng tôi cũng chắc chắn rằng có một vài người công bằng biết chính xác những gì tôi đang nói. Tôi không biết mình đã sống sót như thế nào trước khi khám phá phpXRef (và IDE yêu thích của tôi).