問題タブ [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 投票する
3 に答える
14271 参照

phpstorm - phpStorm 7 アップデート docblock

phpStorm に docblock の内容を更新するように依頼する方法はありますか? たとえば、次のコードがある場合

別のパラメータを追加します

私のdocblockに@param $anotherParameterを作成するようにphpStormに依頼する方法はありますか? (1 回のキーストロークまたはメニュー選択で)?

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

php - 自分のファイルのDocblockの読み取り/解析

次のようなdocblockがあると仮定します:

また :

同じファイルでこれらの文字列を使用するために docblock を解析するにはどうすればよいですか?

私の目標は、@versionドキュメントを変更するたびにドキュメント全体でドキュメントブロックの番号を単純に使用することです。別の番号を追加する必要はありません。$version = 'myversion'

docblock パーサー クラスがあることは知っていますが、独自のファイルを読み取る方法が見つかりませんでした。(私自身の質問- 昔から、ある程度の解決策を提供していますが、外部ファイルに対してのみ提供しており、いずれにせよ、毎回ファイルを開いて書き込む必要があるため、理想的ではありません)

また、pear のサンプル ページでは、バージョン番号を (私の理解する限り) 変数として使用しているように見えますが、どうすればよいのかわかりません...

バージョン I

バージョン II :

(2 つのサンプル ページ (URLenzh) が異なる理由はわかりません。これは単なる小さな Web バグかもしれません。) しかし、いずれにせよ、それを適用する方法がわかりません。

ポイントはこれです: docblock をファイル自体の文字列として使用するにはどうすればよいですか? あるいは、ロジックを逆にしてドキュメントの変数を docblock で使用するので、常にバージョン番号 (および場合によっては他の変数) のみを宣言する必要がありONCEます。

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

php - PhpDocumentor 2 で名前空間の代わりに @package を使用する

階層的なドキュメントを生成しようとしている大規模なコード ライブラリがあります。プロジェクトは名前空間を使用しませんが、代わりに @package を使用します。

phpDocumentor2 を使用して、次のファイルからテストとしてドキュメントを生成しようとしました。

ドキュメントによると、@package JustAn\Example は名前空間 JustAn\Example と同等である必要がありますが、そうではないことがわかりました。

名前空間を使用すると、結果のドキュメントは次のようになります。

名前空間のバージョン

@package 表記を使用すると、結果は次のようになります (パッケージ表記を認識しますが、これはクラスの完全な詳細ページに表示されます)。

パッケージ表記バージョン

「実際の」名前空間を使用するようにコードを書き直すことなく、階層的な結果を取得する方法を探しています。

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

php - PHP DocBlock を「再利用」する方法はありますか?

現在、次のようなコードがあります。

それを行うためのより簡潔な方法はありますか?

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

php - PHP docblocks @return タグを使用してブール値を整数 (つまり 1 または 0) として返すためのベスト プラクティスはありますか?

これを行うためのよりクリーンな方法はありますか?

ブール値としてキャストされた値は返されず、整数としてキャストされます。

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

php - MVC でビューを返すときに PHP @return を文書化する方法

したがって、いくつかのメソッド内のコントローラーで、次のようなビューを返したいとしましょう。

ドキュメント ブロックで、このメソッドが何を返すかを文書化したいと思います。このメソッドがビューを返していることを文書化する方法がわかりません。それはリソースですか?混合ですか?

これは有効ですか?:

また、メソッドが他のページへのリダイレクトを返すことをどのように文書化しますか?

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

php - phpDoc - パラメータまたは戻り値なし

次のクラス スタブがあるとします。

このbeCourteous()メソッドは、実際には入力を受け取ったり、戻り値を生成したりしません。正しい phpDoc ブロックは何ですか?