問題タブ [jsdoc]

私の Javascript 関数のほとんどは比較的単純で、その副作用のために呼び出されます。jQuery を使用して DOM を操作したり、Ajax 呼び出しを行ったりしています。私は自分の関数を「モジュール パターンを明らかにする」スタイルで書くことを好みます。

JSDoc-annotating Javascript files には利点があることを発見しました: 注釈の助けを借りて、EclipseのJS Development Tools は私の JS ファイルを解析し、Eclipse Outline View (それ以外の場合は空になります) を埋めることができます。

さて、注釈の細かい点、または良い実践は何だろうか? 私はそれに慣れていません。

Google JS スタイルガイドでは、JSDoc について次のように述べています。他のアドバイスの中でも特に、使用可能なタグのサブセットのみを使用することをお勧めします。

今のところ、このテンプレートを思いつきました(このコードは何も役に立ちません)。

ここで JSDoc タグ @function または @memberOf、またはその両方を使用する必要がありますか? @field タグはどうですか？return 句も JSDoc'umented にする必要がありますか? どのタグで？@public タグは本当に使わないほうがいいのでしょうか? ここは便利だと思います。

推奨事項はありますか？小規模プロジェクト向けの優れた実用的な JSDoc スタイル ガイドを知っている人はいますか?

JSDocがHTML形式で（ディレクティブ、コントローラー、フィルターなどの）素敵なコメントを生成できるようにangularjsプロジェクトを文書化/構造化した経験のある人はいますか？現時点では、いくつかの関数を使用してアプリの名前空間を指す_globalクラスを含む1つのファイルを生成し、それだけです...

または、angularjsでHTMLバージョンのドキュメントブロックを生成するためのより良い方法がありますか？

PS：コードを文書化するために標準のjsdoc構文を使用しています（@ param、@ returnなど）

更新：私の具体的な質問は次のとおりです：すべてのコントローラー/ディレクティブ/フィルターなどをカバーするangularjsドキュメントブロックのhtmlドキュメントを生成する方法はありますか？JSDocコマンドラインユーティリティを実行すると、HTMLレポートのコードの約5％しかカバーされませんでした...

ありがとう！

私は次のようにJSDoc（3）でJavascriptファイルを文書化しようとしています：

現在、ファイル（と呼ばれるconfig.js.in）はそれ自体の有効なJavascript上にありません。ファイルは、の代わりに適切な値を使用するMakefileを介して実行され@HAVE_BLUETOOTH@ます。

これでJSdocを実行しようとすると、ファイルの構文エラーが原因で（当然のことながら）失敗します。

このファイルのすべてのコードを無視するようにJSDocに指示する方法はありますが、単に注釈を考慮に入れるだけですか？@name（ドキュメントをコードから完全に分離するために、各ドックレットにタグを追加する必要があるかもしれません。それで問題ありません）。

何かのようなもの：

可能であれば、ファイルのコード部分を変更したくない（既存のプロジェクトにドキュメントを追加している）。たとえば、私はおそらくそれを回避することができます

これにより、パーサーが文句を言わないように、ファイルに再び有効なJS構文が作成されますが、これは、回避したい元のファイルのコードを変更していることも意味します（ドキュメントを追加することをお勧めします）。

乾杯

JSDoc3 が他のモジュールからクラスへのリンクを自動的に生成する方法を見つけようとしています。言葉で説明するのは難しいと思うので、いくつか例を挙げてみましょう。次のスクリプトは、期待される出力を生成します。

つまり、JSDoc3 は someFunc のパラメーター リストから SomeClass のクラス記述へのリンクを正しく生成します。ただし、外部モジュールに SomeClass を配置すると、JSDoc3 にリンクを生成させることができないようです。

現在、JSDoc3 は両方のファイルのドキュメントを正しく生成しますが、someFunc のパラメーター タイプを SomeClass のページにリンクしません。私は次のものに置き換え@param {SomeClass}てみました：

• @param {SomeClass.SomeClass}
• @param {SomeClass/SomeClass}
• @param {@link SomeClass}
• @param {@link SomeClass.SomeClass}
• @param {@link SomeClass/SomeClass}

しかし、これらのどれも機能しませんでした: すべての場合において、ドキュメントは中括弧内にテキストを表示するだけです (@link を使用した場合でも)。

JSDoc3 に外部モジュールへのリンクを正しく生成させるにはどうすればよいですか?

IntelliJ Ideaを初めて使用するJavaScriptコア用のjsdocを追加したいつまり、.getElementsByTagName（）メソッドなどのjavascript要素でctrl + qショートキーを押すと、ドキュメントが表示されますが、何もありません。 ！！

方法はありますか？ドキュメントを表示するために、ライブラリjarファイルの近くにドキュメントjarファイルを追加するようなものです。

ありがとうモヒ

そのように宣言された変数の型を PhpStorm に理解させる方法:

PhpStorm は最後の変数の型のみを認識し、そのメソッド/属性を提案しますが、変数「a」および「b」の型についてはわかりません。

PhpStorm でタイプを文書化し、JSLint に準拠することは可能ですか? もしそうなら、どのように？

スーパークラスのメソッドをオーバーライドし、Google Closure Compiler を使用してコードをコンパイルしようとしていますが、型が間違っているという警告が表示されます。

ご覧のとおり、スーパー メソッドが受け取る引数の型を変更したり、返される型を変更したりしていません。

この問題を解決する方法を知っている人はいますか? ありがとう。

明確にするために、個々のメソッドの定義を次に示します。

JavaScript ファイルにプライベート関数がある場合:

ドキュメント ブロックを開始すると、IntelliJ がスタブ化してくれるので、次のようになります。

下線付きの関数をプライベートとして扱うようにJsDocを既に構成しているので、コメントに追加しないでください。@privateコメントに追加しないように IntelliJ を構成することは可能ですか?

たとえば、NodeJS用のQライブラリを使用して、promiseオブジェクトを返すコードがあります。

JSDocを使用してそのような戻り値を文書化する方法は？

JSコードを完成させました。これで、それを独自のファイルに移動しました。PHPStormは、$という変数がないことを通知します。これを修正するにはどうすればよいですか？（JSDocはそれを解決できますか？）