Jak udokumentować swój JavaScript?

Question

Muszę udokumentować sporo kodu JavaScript i jQuery. Interesują mnie diagramy, a nie pisemna dokumentacja.

Zastanawiam się, czy istnieje jakiś standard dla modelowania funkcji JavaScript? Moim celem jest pokazanie wizualnego, jak różne funkcje współdziałają ze sobą.

Dziękuję

Edycja: staram DFDS i diagramy sekwencji, ale to działa tak jak bym go lubić. Mam wybór mapowania wywołań funkcji na procesy w DFD, ale to sprawia, że ​​diagram jest zbyt mylący i łatwiej jest przejść przez firebug przeskakując z jednej funkcji do drugiej.

Procesy wywołujące inaczej niż nazwy funkcji oznaczają, że po przeczytaniu diagramu nie będzie tak łatwo zamapować go na javascript ... Za chwilę opiszę kilka scerenshotów.

Answer 1

Nie ma dostępnych dla tego narzędzia, ale według mnie można użyć Schemat UML do tego, który jest stosowany w OOD, aby pokazać przepływ między wywołań funkcji lub użyć diagramy pokazać przepływ sterowania.

Uwaga: zastąpić nazwę obiektu z pliku JavaScript

Przykład diagramu sekwencji

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

Answer 2

Jeśli rozumiem go poprawnie trzeba wykonać dokumentację dla projektu/produktu, prawda?

Może MS Visio mogą być przydatne dla Twoich potrzeb. Jest to oprogramowanie, dokumentacja, która służy do tworzenia diagramów przepływu danych (DFD) itd

Może mógłbyś to wykorzystać do modelowania ci kodu JavaScript/jQuery.

O ile mi wiadomo, jest to dobre dla dokumentacji.

Wypróbuj lub wyszukaj podobne rzeczy.

Mam nadzieję, że jest to pomocne.

Jest jeszcze jeden taki, Rational Rose.

Answer 3

przypadku prostych diagramów sekwencji, niedawno odkryte websequencediagrams.com i to jest dobre dla moich potrzeb. Prosty, konfigurowalny i możliwy do wbudowania. Spróbuj!