Bạn làm cách nào để ghi lại JavaScript của mình?

Question

Tôi cần ghi lại khá nhiều mã JavaScript và jQuery. Tôi quan tâm đến các biểu đồ hơn là tài liệu viết.

Tôi tự hỏi liệu có một số loại tiêu chuẩn nào cho các chức năng JavaScript mô hình hóa không? Mục tiêu của tôi là hiển thị trực quan các chức năng khác nhau tương tác với nhau như thế nào.

Cảm ơn bạn

Edit: Tôi đã cố gắng DFDS và trình tự sơ đồ, nhưng nó làm việc cũng như tôi muốn nó. Tôi có một sự lựa chọn lập bản đồ các lời gọi hàm tới các quy trình trong DFD, nhưng điều đó làm cho sơ đồ quá khó hiểu và dễ dàng hơn để đi qua một con đom đóm nhảy từ một hàm này sang hàm khác.

Quá trình gọi với tên hàm khác nhau có nghĩa là sau khi tôi đọc biểu đồ, sẽ không dễ dàng để ánh xạ nó tới javascript ... Sẽ đăng vài lần scerenshots trong một chút.

Answer 1

Không có công cụ có sẵn cho việc này, nhưng theo tôi bạn có thể sử dụng một sơ đồ chuỗi UML cho điều này được sử dụng trong OOD để hiển thị dòng chảy giữa các chức năng cuộc gọi hoặc bạn có thể sử dụng biểu đồ dòng chảy để hiển thị dòng điều khiển.

Lưu ý: thay thế tên đối tượng với JavaScript nộp

Ví dụ về sơ đồ chuỗi

alt text http://click.sourceforge.net/images/get-sequence-diagram.png

Answer 2

Nếu tôi hiểu nó một cách chính xác bạn cần phải thực hiện tài liệu cho dự án/sản phẩm của bạn, phải không?

Có thể MS Visio có thể hữu ích cho nhu cầu của bạn. Đây là phần mềm tài liệu được sử dụng để tạo sơ đồ lưu lượng dữ liệu (DFD), v.v.,

Có thể bạn có thể sử dụng nó để lập mô hình mã JavaScript/jQuery.

Theo tôi biết điều này là tốt cho tài liệu.

Hãy thử tính năng này hoặc tìm kiếm những thứ tương tự.

Tôi hy vọng nó hữu ích.

Có một số khác như thế này, Rational Rose.

Answer 3

Đối với các biểu đồ trình tự đơn giản, gần đây tôi đã phát hiện websequencediagrams.com và điều này rất phù hợp với nhu cầu của tôi. Đơn giản, có thể tùy chỉnh và có thể nhúng. Thử nó!