問題タブ [jsdoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
eclipse - Eclipse JSDT-サポートされている機能の完全なリスト?
EclipseのJSDTJavascriptサポートでサポートされているものとサポートされていないものの明確なリストを入手できる場所はありますか?
Eclipseで提供されるドキュメントは非常にまばらです。私の実験者はかなり紛らわしい結果を出しているので、私はJSDOcタグがサポートされている場所と場所に特に興味があります。
他の機能(完了、リファクタリング)の詳細にも興味があります。
グーグルは何も有用なものを生み出していません
eclipse - Eclipse JSDT - 関数引数の型の宣言
Eclipse ヘリオスの使用:
簡単なJavascript関数を定義すると
- タグは、Alt-Shift0J によって自動的に追加されたものでした。関数の推定型は次のとおりです。
Eclipseもパラメーターが後で「{String} arg」であることを認識するにもかかわらず、「任意の引数」に注意してください。
私が試みたものは、引数の推論された型を「any」以外のものにすることはできませんでした。これは、非 String での関数の呼び出しが検出されないことを意味します。これは残念です。
それで、これはバグですか?動作しないはずですか?私が間違っていることはありますか?
linux - Linuxシェルは変数パラメータをコマンドに追加します
このような特定のパラメーターに対してJSDocを生成するbashスクリプトを取得しようとしています
次のシェル コマンドに不明な数のパラメータを渡す方法に行き詰まっています。
(また、 param が存在するかどうかを確認する方法がわからない、ない場合のみ exitst if [ -z ... ]
)
このコードは最大 2 つのパラメーターに対して機能しますが、明らかに正しい方法ではありません...
これを達成する方法についての他の指針をいただければ幸いです。
編集:@skjaidevの回答に従ってスクリプトを更新しました-幸せな日々;)
javascript - 軽量マークアップを使用したJavascriptAPIドキュメントフレームワーク
JSDocと同様の機能を備えたJavascriptAPIドキュメントフレームワークを探していますが、コードコメント(htmlではなく)で入力しやすい再構成されたテキストまたはマークダウンを使用します
ボーナス:Sphinxとうまく統合できます。ただし、個別のドキュメントを維持したくはありませんが、コメントからAPIドキュメントを生成します。
javascript - グーグルクロージャーのtypedefは実際に何をしますか?
私はそれが何のためにあるのかを理解しています-複合型のエイリアスを定義し、それをドキュメントで使用できることの利点を見ることができます。したがって、次のような型を定義できます...
...そしてそれを使用して、次のような関数を文書化します...
しかし、私がよくわからないのは、それがドキュメントとコンパイラの静的型チェックにのみ使用されている場合、typedefがJavaScriptのその行を必要とするのはなぜですか?エイリアスは、ドキュメントのコメントブロック内で完全に定義することはできませんか?また、コードを(コンパイルせずに)直接提供した場合、JavaScriptインタープリターはtypedefコメントの後のそのコード行をどのように処理しますか?
vim - VimでjsDocインテリセンスを取得するための最良の方法は何ですか
私は最近vimを使用するように変換し、完全に販売されています。
jsdocコメントとctagsを使用して、インテリセンスや関数にジャンプする機能を取得するための優れた方法を見つけられませんでした。
これはどうやるんですか?
javascript - JavaScript で名前空間を文書化する方法は?
jsDoc を使用して JavaScript で名前空間をどのように文書化できますか?
これが私の試みです。これでよろしいですか?
明確にするために、上記は次のように使用されます。
javascript - JsDoc ツールキットと名前空間 - .. なしで実行しようとしている警告
Mike Koss の名前空間ライブラリでjsdoc-toolkitを使用しています。コードは次のようになります
ドキュメントの作成 次のメッセージが表示され、このクラスのドキュメントはまったく作成されません。
パラメータ行の問題を克服しようとしましたが、成功しませんでした。
問題を克服する方法はありますか?
javascript - 別のファイルで宣言されているグローバルのタイプを指定する
特定のグローバル変数が「宣言されていない」のではなく、単に他の場所で宣言されていることを IDE (PHPStorm) に伝えるにはどうすればよいですか。特定のタイプがありますか?
Magento の例 ( opcheckout.js
):
私がやりたいことは次のようなものです:
javascript - JSDoc で _methods を文書化するにはどうすればよいですか?
このメソッドを含むクラスがあります
パブリック インターフェイス用のメソッドと_
区別するために、接頭辞が付けられています。replace
前に があるのに、JSDoc がこのメソッドを文書化しないのはなぜ_
ですか? それを削除すると、完全に文書化されます。この方法で JSDoc ドキュメントを作成するためにできることはありますか?