私はコンピューターが得意ではありませんが、プロジェクトの 1 つで JSDoc を使用しようとしています。
起動して実行するためのチュートリアルはこちら
http://usejsdoc.org/about-jsdoc3.html
プログラムを github からダウンロードしましたが、何をしなければならないのかわかりません。フォルダーにたくさんのファイルがあり、プロジェクトで実際に実行する方法がわかりません。
JSDocを実際に機能させる方法、設定方法、使用方法などについて、順を追って説明してください。
一部の人にとってこれはありふれたことかもしれませんが、私たちは皆、どこかから始めなければなりませんか?
Windows または GNU/Linux を使用していますか? まず、デフォルトのタグに従ってソース コードをマークアップし、クラス、メソッド、パラメーターなどを特定する必要があります。その後、https ://github.com/jsdoc3/jsdoc からファイルをダウンロードして 解凍します。次に、フォルダー jsdoc-master に移動します。
その中に、jsdoc (拡張子なし) というスクリプトがあります。次のようなドキュメントを作成する.jsファイルへのパス全体を指定して実行するだけです: ./jsdoc your_class.js その後、数分で「out」フォルダー内に出力が得られます. .html ファイルを開いて、バン！ドキュメントはかなりうまく機能しています。
ここに、コードで (コメントとして) 使用する一般的なタグがいくつかあります: http://usejsdoc.org/
このソリューションは、Unix ベースのシステム用です。しかし、nodejs を使用する別のものがあります (Windows、Linux、Mac などで実行できます)。まず、nodejs をここからダウンロードします: http://nodejs.org/
次に、この Web サイトにアクセスして、パッケージ jsdoc を確認します: https://npmjs.org/
次に、(ノードをインストールした後の任意のオペレーティング システムで) ターミナルに戻り、次のように入力します。持っていて、何度もインストールする必要はありません...
最後に、次のコマンドを使用できます: jsdoc path/to/your/file.js
以上です！お役に立てば幸いです。
github からダウンロードしたファイルを抽出したら、フォルダー内を移動し、ターミナルで実行します。
./jsdoc
あなたが望むオプションで。
ヘルプメニューを表示したい場合
./jsdoc --help
システムにプログラムをインストールする場合は、Mac または Linux マシンを想定して、root ユーザーまたは を使用しますsudo。
npm install --save -g [~/Downloads/jsdoc-3.2.2 or your path to the downloaded extracted files]