問題タブ [docblocks]

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.

0 投票する
1 に答える
3011 参照

phpstorm - phpストームカスタマイズdocblock

php stormのdocblockの生成方法をカスタマイズする方法はありますか?

デフォルトでは、不明なタイプの変数を文字列と見なしたいと思います。

これは、docblockを生成するデフォルトの方法です(php storm 4.01を使用)

そして、可能であれば代わりにこれが欲しいです:

0 投票する
3 に答える
5310 参照

autocomplete - DocBlock で無制限/可変パラメータを宣言する方法は?

私が関数を持っているとしましょう(明らかに些細な例です):

今、私はこれを次のように変更できることを知っています

ただし、オプションではないいくつかの機能があります。では、関数の最初のバージョンを docBlock で文書化して、IDE が無制限のパラメーターを受け取ることができると解釈できるようにするにはどうすればよいでしょうか?

以下を使用するいくつかの方法を見てきました。

IDE では次のようになりますオートコンプリートの例

しかし、それは私にはハックのように感じます.docBlockだけでそれを行う方法はありませんか?

0 投票する
1 に答える
2864 参照

php - PHP Docblocks - 配列の説明

重複の可能性:
phpDoc がオブジェクトの配列をパラメーターとして文書化する方法はありますか?

私は探していて、phpDocumentor のドキュメントを見てきましたが、解析されて生成されたドキュメントに含まれる @param 配列を適切に文書化する方法があるかどうかを見つけることができません (たとえば、期待されるキー/値の型を宣言します)。

これは、それを行う方法がないと私に信じ込ませ、説明を使用することを辞任します.

前もって感謝します。

0 投票する
2 に答える
36411 参照

php - IDEのマジック(_callおよび_callStatic)メソッドを文書化する方法

notepad ++と崇高なコーディングで何年も幸せに過ごした後、PHPIDEを試してみるようにアドバイスされました。phpStormを試していますが、良さそうです。コードの完成とドキュメント化は素晴らしい機能ですが、魔法のメソッドを使用するとうまくいきません。phpStormに魔法のメソッドで何が起こっているのかを理解させるための回避策はありますか?

私たちの状況は次のようなものです。

魔法のcallStaticメソッドを使用すると、関数呼び出しを構成する1つ以上の引数を介してオブジェクトのコレクションを取得できます。

これらの場合に使用する@methodステートメントがあることがわかりますが、phpStormはこれらのステートメントの最初のステートメントのみを取得しています。さらに、return typeをmixedに設定することしかできません。これは、これが呼び出されたクラス(私の例ではb)として設定できるようにするためです。

どんなアイデアや提案も非常にありがたく受け取られます、ありがとう。

0 投票する
1 に答える
291 参照

documentation - DocBlocks:@usesと@seeの違い

かなり簡単な質問-docblockを作成するとき、構造要素を別の要素と言うべきかどうか@uses、そしていつ他の要素を人々に伝えるべきかをどのように判断する必要があり@seeますか?

私は少しのグーグルと少しのSO検索を運が悪かったのですが、私が見ることができる唯一の違い@usesは、一致する@used-byタグがあるのに対し、一方@see通行であるということです。@usesこれは、 /@used-byが優先されることを意味しますか、@seeそれともそれ以上のものがありますか?

乾杯。

0 投票する
2 に答える
589 参照

php - 関数定義ではなく、関数呼び出しの docblock を解析しますか?

PHP ファイル内の特定の関数呼び出しの前にある docblock を取得しようとしています。通常のアプローチとの違いは、関数定義の docblock を解析しようとしていないことです。

サンプルファイル:

do_function解析するさまざまなファイルのさまざまな場所に表示されます。私が取得して解析しようとしているのは、関数呼び出しを含む先行する docblock です。

ファイルにはクラスが含まれていないため、Reflection クラスはオプションではないため、空の配列を返す次の RegExp に行き詰まっています。

ここで何が間違っていますか?ありがとう!