問題タブ [phpdoc]

コメントで宣言および説明する多くの変数を持つオブジェクトがあります。phpDoc を使用して後で処理するために非常に徹底的にコメントしていますが、実際にドキュメントをコンパイルした経験はまだありません。

phpDoc 表記では、設定したい唯一の属性が説明である場合でも、各変数が 4 ～ 6 行のコードを消費するのは非常に面倒です。

次の表記法を使用したいと思います。

これを受け入れるようにphpDocを微調整する簡単な方法はありますか、それとも実際にドキュメントをコンパイルしようとすると問題が発生しますか? 今は微調整は必要ありません (もちろんありがたいのですが)、コードの大部分を再設計することなくこれが実現可能かどうか、phpDoc を知っている誰かからの声明です。

Zend Framework（またはその拡張）のようなフレームワークでは、PHPDocスタイルのコメントを使用して、タイプヒントなどの情報をフレームワークコードに渡すことができる場合があります。

フレームワークがPHPを使用してファイルを解析することは想像できませんが、私が知らないPHPの組み込み言語機能を除いて、これを実現する他の方法はありません。では、これはどのように行われますか？

一般に、PHPDOCのプロパティは自明ですが、私はこれらを理解するのに苦労しています。

@category-これは正確には何ですか？

@package-誰かが私にこのプロパティの使用法についての例を教えてもらえますか？

私は最近phpDocumentorで遊んでいて、それが私のニーズに非常に適していることを発見しました。私は主にPHP/HTML / JS / CSSコードベースを使用しており、すべてをまとめるためにphpDocumentorでJavascript（およびおそらくCSS）を解析したいと考えています。

コードベース全体に含まれているjavascriptファイルを解析するようにphpdocを取得することができましたが、ページレベルのdocblockを拒否するため、さまざまなタグが拒否されます（以下を参照）。JavaScriptファイルの先頭にPHPオープンタグ（前にJavaScriptコメントが付いている）を追加することで、PHPファイルと同じように解析できることがわかりました。

WebサーバーがPHPを介してサーバー.jsファイルにセットアップされている場合に発生する問題を考えることができます。誰かが考えることができる他の問題はありますか？これを達成するためのより良い方法はありますか？

ありがとう

インテリセンスがそれを拾うように、ネットビーンズに通常の変数の型ヒントを与える方法があるかどうかだけ興味があります。クラスプロパティ、関数パラメーター、戻り値の型などに対してできることは知っていますが、通常の変数に対してそれを行う方法がわかりません。これは、さまざまなオブジェクト タイプを返すことができるメソッド (サービス ロケーターなど) がある場合に非常に役立ちます。

例：

後で $someService を使用すると、netbeans はクラス Some_Service で定義されたすべての使用可能なメソッドを提供します。

javadoc / phpDocumentorスタイルで文書化したいインクルードがたくさんある、いくつかの完成した古いPHPプロジェクトがあります。

各ファイルを手動で処理し、ドキュメントと一緒にコードレビューを強制するのが最善ですが、時間の制約から、タスクを可能な限り自動化するのに役立つツールに興味があります。

私が考えているツールは、理想的には次の機能を備えています。

• PHPプロジェクトツリーを解析し、文書化されていないファイル、クラス、および関数/メソッド（つまり、適切なdocblockコメントが欠落している要素）がある場所を教えてください

• 空の構造を作成し、理想的にはファイルをエディター（内部または外部は関係ありません）で開いて説明を入力できるようにすることで、不足しているdocblockを途中で簡単に追加する方法を提供します。

オプション：

• パラメータタイプ、戻り値などの自動認識。しかし、それは実際には必要ありません。

問題の言語はPHPですが、C/Javaツールで微調整を行うとPHPファイルを処理できる可能性があると想像できます。

素晴らしいご意見ありがとうございます！

phpdocを正しく実行するのに問題があります。ドキュメントはほとんどの部分で正常に生成されていますが、次の警告が何度も表示されます。

警告：日付（）：システムのタイムゾーン設定に依存することは安全ではありません。date.timezone設定または （）関数を使用する必要があります。date_default_timezone_setこれらの方法のいずれかを使用してもこの警告が表示される場合は、タイムゾーン識別子のスペルを間違えている可能性があります。America/Los_Angeles5064行目の/Users/ben/bin/PhpDocumentor/phpDocumentor/Converter.incで、代わりに「PST / -8.0/noDST」に「」を選択しました。

と

警告：strftime（）：システムのタイムゾーン設定に依存することは安全ではありません。date.timezone設定または （）関数を使用する必要があります。date_default_timezone_setこれらの方法のいずれかを使用してもこの警告が表示される場合は、タイムゾーン識別子のスペルを間違えている可能性があります。America/Los_Angeles370行目のPhpDocumentor/phpDocumentor / Smarty-2.6.0 / libs / Smarty_Compiler.class.phpで、代わりに「PST / -8.0/noDST」に「」を選択しました。

Smartyの警告は、レンダリングされたドキュメントのテンプレートの上部にタイムスタンプを生成するだけなので、コードから簡単に削除できます。大したことはありません。phpDocumentorの最初のエラーについてはよくわかりません。テンプレートのSmartyに日付を割り当てているようです。

たぶん、Smartyテンプレートとこの行のすべての「日付」変数を削除するだけで済みます。

とにかく、この警告は生成されたドキュメントにもあり、インデックスページにはこの警告が表示されます。ここで何が起こっているのか考えはありますか？私はバージョン1.4.3を使用していますが、フラグ/オプションは次のとおりです。

PHP プロジェクトのドキュメンテーション システムが必要で、コード コメントから生成されたドキュメンテーションと外部ドキュメンテーション (ユース ケース、プロジェクト スコープなど) を統合できるようにしたいと考えていました。phpDocumentor は正確に適切な機能セットを備えているようですが、外部ドキュメントは DocBook で作成する必要があり、これは私たちのチームにとって複雑すぎます。

それが Python の場合、sphinx はこの仕事にほぼ完璧です (ReST は間違いなく docbook よりも簡単です)。外部の ReST ドキュメントを phpdoc から抽出したドキュメントと統合する方法はありますか? 外部ドキュメントを分離する必要がありますか (たとえば、外部には ReST を使用し、内部には phpdoc を使用します)。または、外部ドキュメントを管理するためのより良い提案はありますか?

オプションの引数を取るこのコンストラクターがあります。これに関する主な問題は使いやすさです。私のフレームワークを使用している開発者は、引数を提供できるかどうか、どのような種類の引数を提供できるか、またはまったく提供できないかどうかわからないため、すぐに頭痛の種になります。結論：それはただひどいです。しかし、誰かがNetbeansのような妥当なIDEをインストールしている場合、PHPDocは少し役立つかもしれません;）

それで：

ここでPHPDocを使用して、オプションの[$ tpl]引数を指定できることを示すにはどうすればよいですか？

PHPDocでヒントできるタイプの概要を見つけることができませんでした。配列または文字列を知っていますが、ブール値もありますか？好き：