dojo js library + jsdoc -> jak udokumentować kod?

Question

Chciałbym zapytać, jak ludzie tworzący dojo tworzą dokumentację?

Od nocnych kompilacji można uzyskać nieskompresowane pliki JS ze wszystkimi komentarzami i jestem pewien, że istnieje pewien rodzaj skryptu dokumentującego, który wygeneruje z tego jakiś HTML lub xml.

Sądzę, że używają jsdoc, ponieważ można je znaleźć w folderze ich narzędzi, ale nie mam pojęcia, jak go używać. jsDoc toolkit używa różnych notacji /**commenting**/ niż oryginalne pliki dojo.

Dzięki za pomoc

Answer 1

To wszystko zrobić z niestandardowych parsera PHP i Drupal. Jeśli spojrzysz w util/docscripts/README i util/jsdoc/INSTALL, możesz uzyskać wszystkie szczegóły dotyczące generowania dokumentów.

Różni się od jsdoc-toolkit lub JSDoc (jak odkryłeś).

FWIW, używam jsdoc-toolkit, ponieważ znacznie łatwiej jest wygenerować statyczny HTML i istnieje dużo dokumentacji na temat tagów na stronie kodowej Google.

Ponadto, aby było jasne, nie rozwijam samego dojo. Po prostu go używam w pracy.

Answer 2

Istnieją dwie części procesu "dojo jsdoc". Istnieje parser, napisany w PHP, który generuje xml i/lub json całości wymienionych przestrzeni nazw (zdefiniowanych w katalogu util/docscripts/modules, dzięki czemu możesz dodać własne przestrzenie nazw.Na są podstawowe instrukcje użytkowania na podstawie pliku "generuj. php ") i część Drupala o nazwie" jsdoc ", która instaluje się jako drupalowy moduł/plugin/cokolwiek.

Aspekt Drupal jest po prostu podstawowym widokiem Dojo tych danych. Dobrze napisany XSLT lub coś w celu iteracji nad jsonem i wytworzenia html działałoby tak samo, chociaż żadne z nich nie jest dostarczane domyślnie (chciałbym mieć wkład!). Unikałem samego Drupala, chociaż od jakiegoś czasu działa on na api.dojotoolkit.org.

Analizator dokumentów jest udostępniony, aby można było wykorzystać jego funkcje inspekcyjne do napisania własnych niestandardowych danych wyjściowych. Używam go do generowania kodu Komodo .cix w [raczej niechlujnym] pliku PHP util/docscripts/makeCix.php, który zrzuca informacje, które zostały znalezione, do dokumentu XML stworzonego w celu dopasowania do specyfikacji. Można to zmodyfikować w celu wygenerowania dowolnego rodzaju wydruku z niewielkim nakładem finansowym.

Składnia doc wszystko jest zdefiniowane na stronie wytycznych styl: http://dojotoolkit.org/reference-guide/developer/styleguide.html