私は数年前からメモ帳++でPHPをコーディングしていましたが、今日はEclipse IDEをダウンロードしました。その機能の1つは、コメントなどの特定の「構文パターン」を自動補完することです。私はphpファイルにコメントとドキュメントを実装するためのさまざまな方法を見てきましたので、私はEclipseの示唆する構文に従うべきかと不思議に思っていました。ここでコード内のドキュメント（コメント）のための最も一般的な/好きな構文ですか？
は私が何を意味するかのスナップです：
あなたはどう思いますか？
マルッティ・レイン
それはphpdocのフォーマット、コメントを使用して自動原稿あなたのコードへの道です。
Eclipseは様々なクラスを文書化する素晴らしい方法ですphpDoc（おそらく最も一般的なPHPプロジェクトのためのソリューションと私は喜んでお勧めです1）の要素、メソッド、メソッドの引数を拾っているように見えますなどの機能を提供するだけでなく、to-doを追跡する手段、推奨されていない関数/メソッドのマーキングなどを提供します。
また、もちろん、phpdocコマンドを使用してHTML、PDF、ラインツール
o phpDoc siteでmore（および必要な構文をチェックアウト）してください。
Eclipseは、heredoc/phpdocコメントを使用するのが最善の方法です。これをドキュメントにコンパイルすることができます。関数を記述してから/ **のコメントを上に置くと、ecpliseは自動的にコメントに関数のパラメータを追加します。
Java APIを見れば、それはそのスタイルのコメントからコンパイルされるドキュメントの種類です。
あなたのコメントをドキュメントにコンパイルするつもりがないと思うなら、それを覚えていなくても、コードの余分なコメントは常に役に立ちます。しかし、それはドキュメントの標準ですので、悪いことではありません。私は多くの他の人が見ていることを知っていることについて、このスタイルのコメントを使用する傾向があります。
他の人に指摘されているように、phpdocのコメントは非常に価値があります。しかし、私はドキュメンテーションを生成するだけでなく、コードを書くことも簡単にできると思っています。いくつかのIDE（少なくともNetbeans）は、利用可能な場合よりも優れたオートコンプリート機能を提供するためにphpdocコメントを使用します。