Perdonami se questa è una domanda stupida, ma sono assolutamente sconcertato su come posso usare JSDoc su Windows. Sono a conoscenza di JSDoc-Toolkit ma è un po 'obsoleto e il repository di codice di google consiglia di utilizzare JSDoc 3. Ho scaricato JSDoc da Github e ho decompresso la cartella jsdoc-master sul mio disco locale, ma non ho trovato alcuna informazione solida su come usarlo per analizzare i miei file.Come utilizzare JSDoc su Windows?
È possibile download it as an npm package per la Node.js JavaScript runtime environment.
Installa JsDoc digitando il seguente comando
npm install -g jsdoc
Eseguire JsDoc/generare documentazione. more info
jsdoc path/to/file.js
Configure jsdoc (opzionale)
Grazie, l'opzione -g è molto utile! Salva la necessità di eseguirlo dalla cartella .bin – OhMyGodThereArePiesEverywhere
Anche se non è necessario eseguirlo dalla cartella '.bin'. npm crea la cartella 'node_modules' e installa il pacchetto nella directory di lavoro corrente a meno che non venga passata l'opzione' -g'. Quindi, se non lo si installa a livello globale, si dovrebbe 'cd percorso/a/project_root' prima di eseguire' npm install' –
Grazie, un'ultima domanda: quando si installa a livello globale, dove è posizionata la cartella jsdoc (quindi posso inserire i modelli lì)? Ho node.js installato su D: \ node, e ho controllato la sottocartella 'node_modules' (inc. In npm). – OhMyGodThereArePiesEverywhere
Ok, quindi penso di capirlo. Non sto dicendo che questo necessariamente dice che questo è il modo corretto, ma ha funzionato per me. Qui va:
1) Installare node.js
2) Aprire un prompt dei comandi
3) Come test, creare una cartella nel vostro disco di root (c:\test) e andare ad esso (cd\test). Immagino ci fosse un qualche tipo di problema di autorizzazione in quanto non ho potuto ottenere i seguenti passaggi per lavorare nella mia cartella desktop.
4) Installare il pacchetto JSDoc: npm -install jsdoc
5) Non ci dovrebbe essere una cartella in test chiamato node_modules
6) Vai .bin sottocartella in node_modules
7) Ci dovrebbe essere un file chiamato jsdoc.cmd. Uso semplice jsdoc myfile.js nel prompt dei comandi per eseguire lo script JSDoc sul file
è necessario modificare il punto 4 in 'npm install -g jsdoc' e non è necessario fare nulla nella cartella' node_modules'. –
La documentazione sul sito web non è molto chiaro come ottenerlo installato. Ti capisco. –