問題タブ [phpdoc]

個々のパラメーターではなく、単一の構成配列を取る関数を文書化するための構文はありますか?

私は特に、これに似たメカニズムを使用する CodeIgniter スタイルのライブラリについて考えています。

だから私の質問は、純粋にテキストの説明を超えて構成配列を文書化するサポートされている方法はありますか? 実際@param [type] [name] [desc]に、PHPDoc が有用な値を解析できる適切なものを指定していますか?

余談ですが、CodeIgniter は実際には、上記のように $config 配列を介して渡された値で独自の値を上書きするだけであり、効果的にプライベート メンバーを上書きできます。私はファンではありませんが、私はそれに立ち往生しています。

Aptana では、クラス内の関数の phpdoc コメントを自動生成する機能を何とか壊してしまいました。現在のプロジェクトにのみ影響するようです。

通常、関数の前の行に /** と入力して Enter キーを押すと、Aptana は正しい @param 値などを含む phpdoc コメントを作成します。何らかの理由でこれを行うと、Aptana は 2 つのコメントを作成します。 . 例えば

グローバル関数でこれを試してみると、正常に動作します。クラス変数とクラス自体にも機能します。

次のようなことをする必要がありますか？

戻り値を持たないメソッドがかなりありますが、コメントにこのようなものを入れるのは本当に冗長に思えます。それを省略するのは悪い形と見なされますか?

NetbeansでPhpDocコメントを自動的にフォーマットする方法は?

コメントを次のように並べたいと思います。

Netbeansを入力 すると、メソッド定義から/**[Enter]すべてのパラメーターが自動的にインポートされます。@paramただし、コメントが既に生成されている場合は、新しい変数を定義に追加します。今何？コメントの再解析をトリガーし、新しく追加されたパラメーターを追加する方法は?

PHP プロジェクトでは、メイン アプリケーションにフロント コントローラー ロジックが使用されている場合でも、多くのスタンドアロン スクリプトや ajax スニペットなどが存在する可能性があります。

スクリプトの最初のコメント ブロックで、スクリプトが受け入れる/要求する GET および/または POST パラメーターと、それらがどのタイプであるかを定義する標準化された方法 (PHPDoc またはその他) はありますか?

私は通常@param、ファイルが関数であるかのように s を追加@returnし、スクリプトの動作と戻り値の説明を追加するだけで自分自身を助けますが、私が知らないより専門的な方法があるかもしれません。

私はmampを介してphpdocを持っています。そして私は彼らのチュートリアルに従い、これをターミナルに入力しました。

もちろん、/path/to/document_root を Web スペース フォルダーに変更しました。

しかし、その後は何ですか？Web インターフェイスを介して phpdoc にアクセスするにはどうすればよいですか?

初日、私はphpDocumentorを使用し、これまでのところ非常にうまくいっていますが、マニュアルでキャッチできなかった質問があります... グローバル変数のドキュメント。

次の場合、このコードをどのように文書化しますか。

1. $someGlobalVar は、クラスの PHP ファイルでdecalren ではありません(undelared にすることもできます)。
2. $someGlobalVar は次のように宣言されます: $someGlobalVar = array(); (phpDocumentor マニュアルのようにスーパーグローバル配列を使用しないでください)。

PHP コード:

編集:マニュアルに示されているようにこれらのグローバルを文書化したいのですが、 @global および @name タグをどこに/どのように配置するかわかりません。

編集 2: getSomeProperty の宣言の直前に、次のスニペットを使用することになりました。

NetBeans IDEがソース コードにインライン ヘルプを表示するように、phpDocumentor 構文を使用します。NetBeans ではすべてが正しいように見えますが、それが正しい方法かどうかはわかりません...

誰でも大丈夫だと確認できますか？

PHPでdefine（）で定義された定数を（ phpDocumentorで）どのように文書化する必要がありますか？

ドキュメントには何も見つかりませんでしたが、sample2.phpに次の例（使用法はわかりません）が見つかりました。

phpDocumentorを使用してPHPで定数を文書化する最良の方法は誰でも教えてくれますか？

次のPHP5クラスを考慮してください。

phpDocumentorで$fooプロパティをどのように文書化しますか？文書化する必要があるかどうかさえわかりませんが、必要な場合はどうすればよいか知りたいです...

SetFoo（）とGetFoo（）を文書化する方法を知っていますが、プライベートプロパティ（変数？）についてはよくわかりません。

ありがとう！

netbeansにはphpdocumentatorが含まれているので、コードにコメントを付けることができますか？

それを使用する方法についてのガイドはありますか？どのようにコメントする必要がありますか、それらを読む方法とそれらを印刷する方法は？