Tôi đã thừa kế hơn 600 tệp mã nguồn ColdFusion chạy một trang web nội bộ cho công ty của tôi. Một trong những nhiệm vụ của tôi là "ghi lại" nó. Các cơ sở mã đại diện cho khoảng 5 năm phát triển và không có đặc tả kỹ thuật của những gì nó làm.Tài liệu tự động của mã ColdFusion
Các nhà phát triển đã duy trì nhật ký thay đổi của từng tệp và có tiêu đề nhất quán.
Suy nghĩ của tôi là tôi có thể xây dựng bản đồ phụ thuộc của các mô-đun khác nhau và các thủ tục được lưu trữ tham chiếu để tạo điều kiện cho tài liệu này bằng cách quét các tệp nguồn. Tôi đã sử dụng Doxygen trong quá khứ cho mã nguồn c + + và tôi tự hỏi nếu một công cụ như thế này tồn tại cho ColdFusion.
Một đầu ra tôi đang điều tra là khả năng tạo tệp xmind như là phương tiện trực quan hóa các phụ thuộc chéo trong mối quan hệ giữa các mô-đun.
Cảm ơn trước,
Chris
"Nhà phát triển đã duy trì nhật ký thay đổi của mỗi tệp và tiêu đề nhất quán". - Điều này chứng minh không có gì khác hơn so với * ý định đã nêu * của nhà phát triển! (Và đó là giả sử họ luôn luôn ghi nhớ để thay đổi nhật ký, vv) –
5 tuổi. 600 tệp. Cơ hội này là mã OO tốt, tất cả trong cfc, có gợi ý (siêu dữ liệu), có thể được sử dụng để tạo ra tài liệu tốt? Có lẽ rất ít. – Mark