問題タブ [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 に答える
182 参照

php - ゲッターとセッターに混在する PHP

私は教義でPhpを使用しており、そのセッター/ゲッターについて質問があります

php.netによると、混合は「混合は、パラメータが複数の(必ずしもすべてではない)タイプを受け入れる可能性があることを示しています...」しかし、 $id が int であり、常に . このようなゲッターとセッターで「混合」を使用する必要があるのはいつですか?

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

php - PHPDocumentor - DocBlock の何が問題になっていますか?

いくつかのレガシー コードにコメントを入れていますが、PHPDocumentor で小さな問題に遭遇しました。

次に例を示します。

コマンドラインから PHPDocumentor を実行すると、ドキュメントでいっぱいの素敵なフォルダーが作成されます。

ドキュメントは問題ないように見えますが、次の行に沿って PHPDocumentor コンパイル エラーが発生します。

それはPHPDocumenatorが不必要に泣き言を言っているだけですか、それとも私が見逃している明らかなものがありますか?

0 投票する
0 に答える
755 参照

php - ページレベルの docblock と phpdocumentor テンプレート

phpDocumentor 2 を動作させるのに本当に苦労しています。

文書化する必要がある手続き型のファイルがいくつかあります。私が見つけた唯一の方法は、ページレベルの docblocksを使用することですが、phpDocumentor バージョン 2 では正しく機能しないようです。

stackoverflow に関する関連する質問は、他の人が同じ問題で実行されることを示しています。この質問には、次の 2 つの提案があります。

  1. namespace文書化する必要があるファイルに a を追加します
  2. phpDoc issue 910以降、テンプレートを使用するかabstractnew-black

残念ながら、どちらも仕事を得ることができません。

  1. 名前空間を追加すると、名前空間自体はドキュメントに表示されますが、ドキュメントブロックの内容は表示されません。
  2. phpDoc 2 の phar バージョンで別のテンプレート (試してみました) を選択すると、zendエラーが発生します。どうやらこれは既知の問題です。abstractnew-blackPHP Warning: XSLTProcessor::transformToUri(): No stylesheet associated to this object in phar

編集:

私はもう一歩です。phpDocumentor の PEAR バージョンをインストールし、利用可能な各テンプレートを試しました。しかし、生成されたドキュメント内のページ レベルの docblocks という目標にはまだ到達していません。
テンプレートは次の 2 つのカテゴリに分類されます。

  • cleanresponsiveresponsive-twigおよびold-ocean: 生成されたドキュメントでページ レベルの docblock を出力しません。
  • abstractnew-blackおよびzend:ファイルごとのドキュメントセクションがあり、予想されるファイル レベルのドキュメントが表示されます。ただし、いくつかのリソース (.js ファイルと画像) が欠落しているため、すべて同じように見え、正しく機能しません (ナビゲーション ペインには展開と折りたたみの動作がありません)。私は彼らの git リポジトリを調べましたが、そこにもファイルがないようです。

この時点で、私は正しい方向を見ているかどうか疑問に思っています.phpDocumentor 2の主要な回帰とバグのために、ファイルレベルのdocblockを示すドキュメントを持つことは不可能です.

本当に間違った方向に進んでいる場合は、私の PHP プロジェクトから貴重なドキュメントを取得する方法を教えてください。私が正しい方向に進んでいる場合は、パズルのどの重要な部分が欠けているかを理解するのを手伝ってください.

0 投票する
0 に答える
31 参照

php - docblock コメントでスパムを防ぐには?

私は頻繁に GitHub で PHP コードを公開しています。私のコードでは、とりわけ次のような私のメール アドレスを含む docblock コメントを使用しています。

これがスパマーを惹きつけるのではないかと心配しており、これを防ぐ方法を探しています。これを行う良い方法はありますか?

一部のオープンソース プロジェクトでは、example.com:foo.bar という形式を使用しているのを見てきました。スパマーを騙すにはこれで十分でしょうか?

よろしく、

0 投票する
0 に答える
961 参照

php - PhpStorm: ランタイム / ロジックの例外を無視する

PhpStorm'sの設定にはEditor/Inspections/PHP/PHPDoc/Missing @throw tag(s)、デフォルトで選択されている 2 つのオプションがあります。

  • 実行時例外を無視
  • 論理例外を無視

スロータグがありません

質問: DocBlock の作成中にこれらの特定の例外を無視したいのはなぜですか? これらのオプションはデフォルトでチェックされているため、これには確固たる理由が必要だと思います。

Logic ExceptionsDomainExceptionまたはのような例外InvalidArgumentExceptionです。または
Runtime Exceptionsのような例外ですRangeExceptionUnderflowException

注: PhpStorm v8.0.3 を使用しています

0 投票する
0 に答える
56 参照

php - DocBlock と Coda

Coda が私の php docBlocks を使用するようにするプラグインを誰かが知っているかどうか疑問に思っていました..?

プログラム自体を検索しましたが、そのオプションはないようです。

また、かなり徹底的なグーグル検索を行ったところ、切り札が出てきました。

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

php - 変数のコメントから変数の型を取得するための正規表現をどのように記述すればよいですか?

以下のように、コメントからプロパティタイプを解析するための正規表現文字列を探しています。

ReflectionProperty クラスを使用して、以下の var ダンプとしてコメントを文字列として取得しています。

どのように正規表現を使用して @var の後に型を返し、他には何も返さないでしょうか。

ありがとう