Które komentarze format dokumentacji jest lepszy dla JavaScript?

Question

Czy istnieje jakiś format dokumentacji komentarzy dla JavaScript i procesora dla tego formatu, który generuje dokumentację HTML?

Obecnie używam komentarzy VSDoc xml do zapewniania pomocy IntelliSense w czasie opracowywania, ale jak wiem, nie ma generatora dokumentacji dla takich komentarzy. A może moje pytanie brzmi: Czy jest jakieś narzędzie, które tłumaczy komentarze VSDoc z plików JavaScript na HTML?

Answer 1

Czy przeglądałeś automatycznie wygenerowaną dokumentację z JavaDoc lub VSDoc lub JSDoc lub czegoś w tym stylu.

Wszystkie są brzydkie i nieczytelne.

Rozwiązaniem jest dwojakie

• annotate your code with docco
• Przekształć swoją dokumentację API ręcznie napisany.

Istnieje trzecia opcja, która ma zrewolucjonizować sposób, w jaki robimy automatycznie generowaną dokumentację, jeśli możesz to zrobić.

Answer 2

Użyłem Natural Docs dla kilku projektów. Składnia jest miła do czytania w tekście, ale ponieważ nie ma "pełnej obsługi językowej" dla JavaScript, musisz być nieco jednoznaczny o każdej funkcji/stałej/klasie/cokolwiek chcesz udokumentować.

Answer 3

Jest to narzędzie, które analizuje pliki JavaScript i wysyła ten sam NDoc formacie XML i Sandcastle zastosowanie: AjaxDoc

w ten sposób można uzyskać intellisense VS z tych samych komentarzach i może wyjście dowolny format, który chcesz.