Cách thích hợp để lập tài liệu hoặc lập biểu đồ các mô hình sự kiện tùy chỉnh trong DOM

Question

Hãy tưởng tượng bạn có một loạt thành phần và thành phần phụ trong ứng dụng web của mình. Bạn muốn theo dõi tất cả các sự kiện tùy chỉnh bạn đã thêm hoạt động như thế nào. Có cách nào được thiết lập để lập biểu đồ hoặc ghi lại các hành vi này không?

Dưới đây là một số điều các tài liệu cần hiển thị:

1. Các tổ thực tế của phần tử DOM có liên quan của các thành phần khác nhau.
2. Tên sự kiện và nơi chúng bị sa thải.
3. Bất kỳ trọng tải nào được đính kèm với sự kiện tùy chỉnh (ví dụ: nội dung của memo trong sự kiện tùy chỉnh Prototype.)
4. Địa điểm mà các sự kiện được quan sát.
5. Chỉ định về sự kiện nào được kích hoạt để phản hồi các sự kiện khác.
6. Nơi sự kiện được phép bong bóng và nơi chúng được dừng lại.

Answer 1

Tôi chưa bao giờ nghe nói về tiêu chuẩn tài liệu được thiết lập cho giao diện người dùng ứng dụng web.

Điều đó nói rằng, vì bạn đã xác định các khía cạnh khác nhau của ứng dụng mà bạn muốn theo dõi, bạn có thể giữ thông tin này trong một tài liệu cho mỗi trình xử lý sự kiện và sử dụng jsdoc toolkit để tạo một số tài liệu nội tuyến. IMHO, tôi nghĩ rằng vì bạn biết rằng bạn muốn tạo tài liệu, bạn nên tạo tài liệu ở bất kỳ định dạng nào phù hợp nhất với bạn, ngay cả khi định dạng này hoàn toàn độc đáo với ứng dụng/tổ chức của bạn. 8 giờ trên stackoverflow không có câu trả lời phải có nghĩa là không có câu trả lời tiêu chuẩn;)

Answer 2

Thành thật mà nói, tôi đã từng sử dụng để mô hình trực quan, và khi MS bán nó cho Visio tôi hơi thất vọng.

Điều đó nói rằng, Visio vẫn là một công cụ tuyệt vời và bạn có thể sử dụng nó để tạo mô hình đối tượng của các thành phần và xác định các sự kiện, thuộc tính, phương pháp vv.

Nhưng tôi phải nói cuối cùng, tôi thường kết thúc bằng notepad hoặc MS word. Tùy thuộc vào mức độ bạn muốn với tài liệu của mình, hãy nhập ghi chú hoặc mô tả cho một thành phần không bao giờ thực sự phù hợp với bất kỳ công cụ DOM nào, nhưng bạn có thể in đậm, tab, liệt kê và in nghiêng như một người điên bên trong tài liệu Word .

Nghe buồn, nhưng đó là sự thật!