問題タブ [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.
javascript - JSDoc で CoffeeScript ソースコードを文書化する方法は?
CoffeeScript で記述されたコードがあり、生成された JavaScript を Google Closure Compiler で最適化したいので、これらのファイルを JSDoc で文書化する必要があります。
私の質問は、 *.coffee ファイルを文書化して、クロージャーコンパイラー用の動作する JSDoc を含む JavaScript を生成するにはどうすればよいですか?
もう 1 つ質問: *.coffee に 1 行のコメントを残す方法はありますか?
javascript - 自己変数を使用すると、jsDoc Toolkit のメソッド、フィールド、およびプロパティが表示されない
ツールキット
クラスを文書化しようとしていますが、「自己」変数を使用してパブリック メソッドのみを公開しています。
jsDoc はクラス名を見つけることができますが、メソッド、フィールド、プロパティなどを見つけることができません...
これは私のクラスの1つです:
これにどのようにアプローチすべきか提案はありますか?
ps: Knockoutjs と jQueryMobile を使用しています
編集：
ありがとう！ほとんどそこに...私はこのようなことをしようとしました:
jsDoc では、「events」ではなく「self.events」のように表示されます
javascript - jsdoc-toolkitを使用して無名関数（クロージャー）を文書化する方法
JSDoc-toolkitを使用してコードを文書化しようとしています。私のコードは、自己実行型の無名関数でラップされることから始まります。いったいどうやってこれを文書化するのですか？私はこれにほぼ一日を費やしました。JS Docsは、匿名関数クロージャをどう処理するかわからないため、匿名関数クロージャ内の何も認識しません。それは壊れて、私のコメントはどれも通らない。
私のコードは次のようになります。
ありがとうございました！
javascript - 次のJavascript関数で「this」の使用法をClosure Compilerに注釈するにはどうすればよいですか?
次の関数を使用して、Javascript 配列の特定のインスタンスの動作を変更しています。Closure Compiler のコードに注釈を付けるにはどうすればよいですか? http://code.google.com/closure/compiler/docs/js-for-compiler.htmlコンパイラでコードを実行すると、「JSC_USED_GLOBAL_THIS」エラーが発生します。
@extends または @constructor アノテーションを使用できるようには見えません。
ページで他のコードが使用されている場合に意図しない副作用が生じるため、グローバル Array プロトタイプを変更したくありません。また、 http://perfectionkills.com/how-ecmascript-5-still-does-not-allow-to-subclass-an-array/を読んだ後、私のアプローチは私のユースケースに最適だと思います。問題は、コンパイラに注釈を付ける方法がわからないことです
javascript - オブジェクトプロパティを文書化する方法は？
期待されるオブジェクトプロパティを使用してオブジェクトプロパティを文書化するにはどうすればよいですか？たとえば、オブジェクトがこれである場合：
そしてポイントはこの構造を持っていました：
とにかく、ポイントにxプロパティとyプロパティが必要であると言うことはありますか？もちろん、説明でそれを行うことはできますが、次のように実行できるパラメータのように、より良い方法を探していました。
javascript - JSDocのドキュメントコレクション（型の配列）の戻り値とパラメーター
Array配列要素が次のいずれかになり得る場合に、JSDocで戻り値（およびパラメーター）を文書化する方法：
- タイプ（例
String、Array）。 - オブジェクトリテラル。
javascript - Visual Studio オートフォーマッタが JSDoc コメントを尊重するようにするにはどうすればよいですか?
Visual Studio 2010 は、Javascript ファイルを自動フォーマットするときに JSDoc スタイルのコメントを壊すようです。
例えば
になる
ドキュメントをフォーマットした後。
これを修正する方法はありますか - VS のカスタマイズ、拡張機能の使用などはありますか?
javascript - JSDocの例に個別に説明を追加するにはどうすればよいですか?
各コード例に個別に説明を追加したいと思います。
例えば：
これはJSDocでどのように行うことができますか?
yui - Closure Compiler と YUI Compressor の注釈形式が異なるのはなぜですか?
Google で検索しようとしましたが、Google Closure Compiler と YUI Compressor が異なる注釈形式を使用している理由については何も見つかりませんでした
Google Closure Compiler は、注釈が で始まる JSDoc 形式を使用しています/**
。異なる形式の注釈はすべて削除されます。
YUI Compressor は、それらが開始された場合にのみ注釈を保持します/*!
ほとんどのライブラリ（jQueryなど）が使用していることに気づきました/*!
ほとんどのライブラリ/*!が JSDoc (かなり人気があると思いますか?) 形式を使用しない理由を教えてください。
Google Closure Compiler がアノテーションの先頭を保持するためのフラグが見つかりませんでした/*!
Google Closure Compiler を使用して両方の形式の注釈を含むファイルを解析し、すべての注釈を保持する最良の方法は何ですか? 縮小後にストリームエディタを使用して置き換えたり元に戻したりするシェルスクリプト/*!は/**?
どうもありがとう！