JSDoc generiert online

Question

Gibt es eine Möglichkeit, HTML aus Jsdocs online oder mit einem eigenständigen Tool zu generieren? Ich habe eine interne JS-Bibliothek erstellt und diese mit JSDoc-Spezifikationen dokumentiert und möchte nun eine Dokumentation generieren, die ich mit meinem Team teilen kann. Ich kann nicht, aus Gründen, auf die ich nicht eingehen werde, das jsdoc npm Paket installieren, wie ich zu Hause wäre.

Gibt es also eine Möglichkeit, die HTML-Dokumentation (oder ähnliches) zu generieren, ohne JSDoc zu installieren?

Answer 1

Wenn Sie die JSDoc-Dokumentation benötigen, müssen Sie über JSDoc package installieren oder kopieren. Da das Paket JavaScript-basiert ist, müssen Sie zuvor node.js auf Ihrem Computer als JS-Laufzeitumgebung installiert haben. Wenn Sie node.js auf Ihre Arbeit Computer installiert haben, können Sie das Paket

npm install -g jsdoc 

oder einfach kopieren (von Ihrem Computer zu Hause) „node_modules/.bin“ und „node_modules/jsdoc“ Ordner überall auf Ihre Arbeit installieren Computer. Nach dem Generieren Sie Ihre Dokumentation von command line

.bin/jsdoc path/to/file.js 

Weitere Informationen zum Thema Verwendung ist hier: How do I use JSDoc on Windows?.

Hinweis: Ich bin mir nicht bewusst, dass ein Online-Dienst JS-Dokumentation generiert, aber selbst wenn, würde ich Ihnen nicht raten, sie zu verwenden. Das Skript, das Sie geschrieben haben, ist geistiges Eigentum von ypur (oder Ihrer Firma) und sendet es an irgendeinen Drittanbieter-Dienst, selbst um Dokumentation zu erzeugen, klingt seltsam. Ich würde zu Hause Dokumentation erstellen und sie in Ihrem Fall zur Arbeit bringen.

Answer 2

Es gibt einen Online-Generator in sanstv.ru, es ist natürlich schrecklich langsam.

stieß ich auf sie, während auf einem iPad und war die beste Wahl, aber Sie sollten jsdoc

https://sanstv.ru/jsdoc

Es ist in der Tat fällt auf, dass es nicht mehr ist da draußen installieren.

Prost,