Przebacz mi, jeśli to głupie pytanie, ale jestem całkowicie zaskoczony, w jaki sposób mogę używać JSDoc w systemie Windows. Jestem świadomy JSDoc-Toolkit, ale jest nieco przestarzały, a repozytorium kodu Google zaleca użycie JSDoc 3. Pobrałem JSDoc z Github i rozpakowałem folder jsdoc-master na mój dysk lokalny, ale nie mogę znaleźć żadnych solidnych informacji o tym, jak go użyć do parsowania moich plików.Jak korzystać z JSDoc w systemie Windows?
Można download it as an npm package dla Node.js JavaScript runtime environment.
Install JsDoc, wpisując następujące polecenie:
npm install -g jsdoc
Uruchom JsDoc/generuj dokumentację. more info
jsdoc path/to/file.js
Configure jsdoc (opcjonalnie)
Dzięki, opcja -g jest bardzo przydatna! Zapisuje konieczność uruchomienia go z folderu .bin – OhMyGodThereArePiesEverywhere
Mimo to nie musisz uruchamiać go z folderu '.bin'. npm tworzy folder 'node_modules' i instaluje pakiet w bieżącym katalogu roboczym, chyba że zostanie przekazana opcja' -g'. Więc jeśli nie instalujesz go globalnie, powinieneś 'cd path/to/project_root' przed uruchomieniem' npm install' –
Dzięki, ostatnie pytanie: podczas instalacji globalnej, gdzie znajduje się folder jsdoc (dzięki czemu mogę umieścić tam szablony)? Mam węzeł node.js zainstalowany na D: \ node, a ja sprawdziłem podfolder 'node_modules' (np. W npm). – OhMyGodThereArePiesEverywhere
Ok, więc myślę, że to wymyślę. Nie mówię, że to koniecznie mówi, że to jest poprawna droga, ale zadziałało to dla mnie. Tu idzie:
1) Instalacja node.js
2) Otwórz wiersz polecenia
3) w teście, utwórz folder napędu głównego (c:\test) i przejdź do niego (cd\test). Wydaje mi się, że był jakiś problem z uprawnieniami, ponieważ nie mogłem wykonać następujących kroków, aby pracować w moim folderze na pulpicie.
4) Zainstaluj pakiet JSDoc: npm -install jsdoc
5) Nie powinno być folder w test nazywa node_modules
6) Idź do .bin podfolder w node_modules
7) Nie powinno być plik o nazwie jsdoc.cmd. Proste użycie jsdoc myfile.js w wierszu polecenia, aby wykonać skrypt JSDoc na pliku
musisz zmienić krok 4 na 'npm install -g jsdoc' i nie musisz nic robić w folderze' node_modules'. –
Dokumentacja na stronie internetowej nie jest jasne w jaki sposób dostać go zainstalowanego. Czuję Cię. –