JSDoc

JSDoc może produkować dokumentację w wielu różnych formatach tekstowych, takich jak HTML, XML, JSON, i tak dalej.

JSDoc był wcześniej znany jako JSDoc Toolkit

Dawne wersje JSDoc używane Java do analizowania kodu źródłowego, wyodrębnić komentarze i generowania dokumentacji. Od gałęzi 3.x node.js jest używany.

Poza node.js, JSDoc może również pracować z silnikiem Mozilli Rhino, jak również.

Aby prawidłowo korzystać JSDoc, zajrzyj do jego dokumentacji informacji na temat formatowania komentarzy kodu źródłowego, więc mogą być wykrywane i wykorzystywane przez silnik JSDoc w.

Co nowego w tym wydaniu:.

• Czy teraz uruchomić JSDoc na node.js
• Może teraz używaćinterface iimplements tagów dokumentowania interfejsów i ich implementacje.
• inheritDoc ioverride tagi zamknięcia kompilatora są teraz obsługiwane.
• Jeśli JSDoc komentarz dla symbolu zawiera znacznikmixes, wszystkich wstawek pojawić się w dokumentacji symbolu.
• JSDoc mogą teraz rejestrować informacje do konsoli, jak to działa (na przykład, nazwę każdego pliku, który JSDoc analizuje). Aby się zalogować, należy uruchomić tę informację JSDoc z --verbose flagi.
• Czy teraz użyć dowolnego pliku jako pakietu lub pliku README w dokumentacji. Użyj -P / - pakiet / i -R / -. Flagi readme określić plik pakietu i README
• typografii i kolorystyki Domyślny szablon zostały znacznie ulepszone.

Co nowego w wersji 3.3.2:

• Czy teraz uruchomić JSDoc na Node.js.
• Może teraz używaćinterface iimplements tagów dokumentowania interfejsów i ich implementacje.
• inheritDoc ioverride tagi zamknięcia kompilatora są teraz obsługiwane.
• Jeśli JSDoc komentarz dla symbolu zawiera znacznikmixes, wszystkich wstawek pojawić się w dokumentacji symbolu.
• JSDoc mogą teraz rejestrować informacje do konsoli, jak to działa (na przykład, nazwę każdego pliku, który JSDoc analizuje). Aby się zalogować, należy uruchomić tę informację JSDoc z --verbose flagi.
• Czy teraz użyć dowolnego pliku jako pakietu lub pliku README w dokumentacji. Użyj -P / - pakiet / i -R / -. Flagi readme określić plik pakietu i README
• typografii i kolorystyki Domyślny szablon zostały znacznie ulepszone.

Co nowego w wersji 3.3.0:

• Czy teraz uruchomić JSDoc na Node.js.
• Może teraz używaćinterface iimplements tagów dokumentowania interfejsów i ich implementacje.
• inheritDoc ioverride tagi zamknięcia kompilatora są teraz obsługiwane.
• Jeśli JSDoc komentarz dla symbolu zawiera znacznikmixes, wszystkich wstawek pojawić się w dokumentacji symbolu.
• JSDoc mogą teraz rejestrować informacje do konsoli, jak to działa (na przykład, nazwę każdego pliku, który JSDoc analizuje). Aby się zalogować, należy uruchomić tę informację JSDoc z --verbose flagi.
• Czy teraz użyć dowolnego pliku jako pakietu lub pliku README w dokumentacji. Użyj -P / - pakiet / i -R / -. Flagi readme określić plik pakietu i README
• typografii i kolorystyki Domyślny szablon zostały znacznie ulepszone.

Co nowego w wersji 3.2.2 / 3.3.0-beta1:

• Skierowany regresji w JSDoc 3.2.1, które mogłyby zapobiec deklarację funkcji z shadowing deklarację o tej samej nazwie w zakresie zewnętrznej.
• Jeśli klasa dziecko nadpisuje metodę w klasie nadrzędnej bez udokumentowania sposobu zastąpiona, dokumentacja tejże metody jest teraz skopiowane z klasy nadrzędnej.
• Możesz teraz użyć wbudowanych znaczników HTML w promocji cenowych-sformatowanego tekstu. Ponadto JSDoc teraz używa tylko znaczną Markdown parser; parser Markdown-js został usunięty.

wyrażenia
• Rodzaj mogą teraz zawierać o wiele szerszy zakres powtarzalnych typów. Ponadto, można użyć zerowalne i nie zerowalne modyfikatory Zamknięcie kompilator z powtarzalnych typów. Na przykład, wyrażenie typu string ...! (Powtarzalny, bez pustych string) jest teraz analizowany poprawnie.

Co nowego w wersji 2.4.0:

• Naprawiono błąd, który dodał mutiple symbole o tej samej nazwie do dokumentów.
• Dodano wsparcie dla -m możliwością powstrzymania ostrzeżenia dla wielu dokumentów.
• Dodano poprawkę do wsparcia przez brownsea42 podane zmienne użytkownika w linii poleceń.
• Naprawiono błąd, który czasami spowodowane linki do wydarzeń jest nieprawidłowy.

Wymagania :

• włączona obsługa JavaScript po stronie klienta,
• node.js 0.10 lub nowszy,