JSDoc

ソフトウェアのスクリーンショット:
JSDoc
ソフトウェアの詳細:
バージョン: 3.4.0 更新
日付のアップロード: 10 Dec 15
開発者: Michael Mathews
ライセンス: 無料
人気: 11

Rating: 3.0/5 (Total Votes: 2)

<強い> JSDocののように、HTML、XML、JSON、などのテキストベースのフォーマットの広い数のドキュメントを生成することができます。

JSDocのは、以前JSDocのツールキットとして知ってました。

以前のJSDocのバージョンは、ソースコードを解析し、コメントを抽出し、ドキュメントを生成するためにJavaを使用していました。 3.xのブランチので、Node.jsのが代わりに使用されます。

のNode.jsのほかに、JSDocのも同様にMozillaのRhinoのエンジンで動作することができます。

正しくJSDocのを使用するには、それらが検出され、JSDocののエンジンで使用することができるように、ソースコードのコメントの書式を設定する方法については、そのドキュメントをチェックします。

このの新機能のこのリリースでます。

  • 今のNode.js上JSDocのを実行できます。
  • 今のインタフェースとその実装を文書化する@interfaceと@implementsタグを使うことはできます。
  • 閉鎖コンパイラの@inheritDocと@Overrideタグがサポートされるようになりました。

  • シンボルのJSDocのコメントは@mixesタグが含まれている場合は
  • 、ミックスインのすべてが今のシンボルのドキュメントに表示されます。
  • それが実行されるようになりましコンソールに情報を記録することができますJSDocの(例えば、JSDocのは、解析し、各ファイルの名前)。 、このログ情報を--verboseフラグをJSDocのを実行します。
  • 今、あなたのドキュメントのパッケージやREADMEファイルなどの任意のファイルを使用することができます。パッケージとREADMEファイルを指定するには、READMEフラグます。
  • - パッケージ/及び-R / - -P /を使用してください。
  • デフォルトテンプレートのタイポグラフィーとカラースキームが大幅に改善されています。

<強い>バージョン3.3.2の新のです何ます。

  • 今Node.js. <上JSDocのを実行することができます/ LI>
  • 今のインタフェースとその実装を文書化する@interfaceと@implementsタグを使うことはできます。
  • 閉鎖コンパイラの@inheritDocと@Overrideタグがサポートされるようになりました。

  • シンボルのJSDocのコメントは@mixesタグが含まれている場合は
  • 、ミックスインのすべてが今のシンボルのドキュメントに表示されます。
  • それが実行されるようになりましコンソールに情報を記録することができますJSDocの(例えば、JSDocのは、解析し、各ファイルの名前)。 、このログ情報を--verboseフラグをJSDocのを実行します。
  • 今、あなたのドキュメントのパッケージやREADMEファイルなどの任意のファイルを使用することができます。パッケージとREADMEファイルを指定するには、READMEフラグます。
  • - パッケージ/及び-R / - -P /を使用してください。
  • デフォルトテンプレートのタイポグラフィーとカラースキームが大幅に改善されています。

<強い>バージョン3.3.0の新のです何ます。

  • 今Node.js. <上JSDocのを実行することができます/ LI>
  • 今のインタフェースとその実装を文書化する@interfaceと@implementsタグを使うことはできます。
  • 閉鎖コンパイラの@inheritDocと@Overrideタグがサポートされるようになりました。

  • シンボルのJSDocのコメントは@mixesタグが含まれている場合は
  • 、ミックスインのすべてが今のシンボルのドキュメントに表示されます。
  • それが実行されるようになりましコンソールに情報を記録することができますJSDocの(例えば、JSDocのは、解析し、各ファイルの名前)。 、このログ情報を--verboseフラグをJSDocのを実行します。
  • 今、あなたのドキュメントのパッケージやREADMEファイルなどの任意のファイルを使用することができます。パッケージとREADMEファイルを指定するには、READMEフラグます。
  • - パッケージ/及び-R / - -P /を使用してください。
  • デフォルトテンプレートのタイポグラフィーとカラースキームが大幅に改善されています。

<強い>新しいのバージョン3.2.2 / 3.3.0-β1は何ます。

  • で回帰を対処外側のスコープ内に同じ名前の宣言をシャドウから関数宣言を防ぐことができるJSDocの3.2.1ます。

  • 子クラスがオーバーライドされたメソッドを文書化することなく、親クラスのメソッドをオーバーライドする場合は
  • は、メソッドのドキュメントは今親クラスからコピーされます。
  • これで、マークダウン形式のテキストにインラインでHTMLタグを使用することができます。また、JSDocのは今だけマークされたマークダウンパーサーを使用しています。値下げ-JSパーサが削除されています。
  • 型の式は、現在、反復型のはるかに広い範囲を含めることができます。また、あなたが今、反復型で閉鎖コンパイラのNULL可能と非NULL可能修飾子を使用することができます。たとえば、型の式...!文字列(反復可能な、非NULL可能文字列)が正しく解析されます。

  • 同じ名前でみとめシンボルを追加しましたバグを修正しました。

    <強い>バージョン2.4.0のの新機能でありますドキュメントにます。

  • には、複数のドキュメントのための警告を抑制するための-mオプションのサポートが追加されました。
  • は、コマンドラインで引用されたユーザー変数をサポートするために、brownsea42によってパッチを追加しました。

  • 時々イベントへのリンクが正しくないことに起因する
  • バグを修正しました。

このの要件

  • のJavaScriptクライアント側で有効になってます。
  • Node.jsの0.10以上

同じようなソフトウェア

Bugzilla
Bugzilla

10 Dec 15

LibGit2Sharp
LibGit2Sharp

12 Apr 15

node-stock-data
node-stock-data

13 May 15

Nightwatch.js
Nightwatch.js

10 Feb 16

へのコメント JSDoc

コメントが見つかりません
コメントを追加
画像をオンにする!
カテゴリから探す