問題タブ [jsdoc]

簡単な質問ですが、その「混合型」を文書化するにはどうすればよいですか? のようなすべての可能なタイプをリストするだけ{null|undefined|String|Number|Object}で、1つが欠けていることに気づき、非常に複雑になることを知っています。Mixed キーワードを使用してみましたが、WebStorm などの多くの IDE でエラーがポップアップ表示されます。

アプリケーションを再生するためにすべてのソース ファイルをロードする必要のないシステムを構築する方法を探しています。私の過去のプロジェクトには 200 以上の .js ファイルがあり (冗談ではありません!)、開発した機能をテストするためにページをリロードするのが非常に遅かったです。

Dojo を調べたところ、どうやって動的ローダーを構築したかがわかります。基本的に、単一のコア コンポーネントをロードするだけで、必要に応じて他のすべてがロードされます。

JavaScript でオブジェクトの新しいインスタンスを作成できるようにするファクトリ メソッドをアプリケーションに実装することを考えています。

それ以外の：

new キーワードを使用しない理由は、前者のアプローチでは、コンポーネントがまだ存在しない場合に、遅延読み込み方式でコンポーネントを動的に読み込むことができるからです。ファクトリ メソッドは、ターゲット オブジェクトが定義されているかどうかを調べるだけで、定義されていない場合はそれをロードします。

私が直面している唯一の問題は、IDE が理解しなくなったという事実です。そのuserタイプMyApp.model.Userは確かに良いことではありません。

このジレンマを解決する方法はありますか? そのファクトリメソッドをどうにかしてJsDocにできますか？

こんにちは私はJSDoc-toolkitにカスタムタグを追加しようとしています。私が見つけた唯一の有用なサイトはこれでした：カスタムタグを使用していますが、機能しません。

私も{+data.comment.getTag("customTag")[0]+}運が悪かっただけで試しました。

Closure Compiler を使用してかなり大きなライブラリを実行すると、多くの"Unknown type"警告が表示されます。これらの警告は、型が自己実行型の無名関数で宣言されている場合に発生するようです。これには特別なことは何もありませんが、自己実行関数を取り除くと、型宣言が機能するように見えます (少なくともこの単純なテストでは)。

コードの注釈に何か問題があるのか​​、それともコードに違法なものがあるのか​​ はわかりませんが、これはすべてコーシャであり、API をモジュール化する標準的な方法だと思います。

次のテスト コードは、名前空間 (単純な古い JS オブジェクト) を作成し、列挙型 (オブジェクト リテラル) と関数を関連付けます。

いいですね。クロージャー コンパイラ エラー:

内部で宣言されたいくつかの関数がありjQuery(document).ready(function {})、それらに JSDoc コメントを書きました。問題は、関数呼び出し行にフォーカスしたときにツールチップとして表示できないことです。必須ではありませんが、これに対する解決策はありますか? Aptana IDE を使用しています。ドキュメントを検索し、グーグルも検索しましたが、答えが見つかりませんでした。

jsdoc-toolkit を使用して、以下の形式でコードを文書化するのに非常に苦労しています。私が使用したタグは望ましい結果をもたらすように見えますが、そうではありません。代わりに、Class が文書化されておらず (クロージャー内でのみ定義されているため)、名前空間のメンバーのリストに Class が含まれていないことを警告します。

可能であれば、@name タグを使用せずにこれを文書化したいと思います。誰でも助けることができますか？

ADVANCED_OPTIMIZATIONS コンパイル レベルで Google Closure Compiler を使用しており、あらゆる種類の警告が表示されるため、コンストラクターに注釈を付け始めました。

警告 - グローバルな this オブジェクトの危険な使用

「コンストラクタ」タイプの関数については、次のように注釈を付けます。

それはうまくいくようですが、 var myFoo = new Foo(); で構築されていない「シングルトン」オブジェクトがある場合はどうなりますか? このタイプのオブジェクトに注釈を付ける方法をドキュメントで見つけることができませんでした。そのタイプは単なるオブジェクトですよね?

これが取引です、

Aptana、Eclipse、またはMicrosoft Expression Webエディターを使用したことがある場合は、組み込みおよびカスタムのオブジェクト、メソッドなどのヒント/情報を示すバルーンテキストまたはIntellisenseポップアップが特徴であることがわかります。

JSDoc、PHPDoc、JavaDoc、RDocなどを通じて情報を取得します。

これらの機能をVimで取得したいのですが、おそらくオムニコンプリートとして実装され、Mac / GVimはバルーンテキストもサポートしているので、これも同様です。

@paramのJSDocwikiによると、@paramはオプションであると指定できます。

を使用してインラインでパラメータを指定できます

そして、私はそれらを次のように組み合わせることができます、それはうまくいきます。

しかし、可能であれば、すべてをインラインで実行する方法があるかどうかを知りたいと思います。

jsdocで可変パラメータをドキュメント化する方法は? 「文字列の配列」のようなタイプのパラメータをドキュメント化する方法はありますか?