phpdoctagsareStructured notationsは、codeforbetternStundingupport; 1）@paramdesscribesfunctionPithtypeandescription、2）@returnSpeciesthereturtypeandEning、3）@slowsIndicatesPossibleExtions、およびtogethertherthertheyeenhancei

PHPは、コンピレーション段階でコメントが破棄され、OpCode実行プロセスに入力されないため、コメントの実行オーバーヘッドを無視します。 2。唯一の無視できるパフォーマンスへの影響は、スクリプトが最初にロードされたマイクロ秒の解析時間であり、Opcacheが有効になった後はほとんど影響がありません。 3。コメントの數ではなく、データベースクエリやループなどの実際のパフォーマンスボトルネックを優(yōu)先する必要があります。

CSVの見出し線をスキップするなど、「何をすべきか」ではなく「なぜ」を説明します。 2。より少ないインラインコメントを使用し、複雑なロジックを明確な関數名に置き換えます。 3.フォールバックメールボックスが空の場合はGDPRに準拠しているなどのエッジケースを示します。 4. phpdocを使用して、パブリックAPIパラメーターと例外を標準化します。 5.コメントを最新の狀態(tài)に保ち、時代遅れのコメントはコメントなしよりも悪いです。

ログまたはバージョン制御によって公開される可能性があるため、コメントに機密情報（パスワード、APIキーなど）を記述しないでください。代わりに環(huán)境変數またはキー管理ツールを使用する必要があります。 2.混亂を引き起こすコメントで時代遅れのコードを「注釈」しないでください。直接削除してgit履歴によって復元し、必要に応じて削除の理由を説明する必要があります。 3.明らかなナンセンスなコメント（「空の配列の作成」など）を書かないでください。変數名を自分で解釈し、論理が複雑な場合にのみ「なぜ」を説明します。 4.責任者や締め切りなしに大きなtodo/fixmeを離れないでください。これらは簡単にゴミになります。プロジェクト管理ツールを使用してそれらを追跡するか、コメントで擔當者と締め切りを示す必要があります。

サードパーティライブラリのバグやパフォーマンスの最適化をバイパスするなど、非自明なロジックを説明します。 2。複雑な関心計算などの複雑なアルゴリズムまたは數學的式を記録します。 3。To-Doアイテムまたは一時的な修正をマークし、// todo：or // fixmeを使用します。 4.パブリックメソッドの構文を複製するのではなく、有用で簡潔なPHPDOCを使用して意図を説明します - 要するに、他の人が「なぜこのように書くのか」と混同される可能性があるとコメントし、そうでなければコードを清潔に保ちます。

XSSおよびSQL注入を防ぐために、htmlspecialchars（）および前処理ステートメントを使用します。 2。トリム（）、長さチェック、およびfilter_var（）を介して入力を確認します。 3.ハニーポットフィールドまたはRecaptChav3を追加して、スパムコメントに抵抗します。 4. CSRFトークンを使用して、フォームのソースが信頼できることを確認します。 5.ストレージ中およびHTMLPurifier中にプリプロセシングステートメントを使用して、ディスプレイ前にコンテンツを浄化し、安全なPHPコメントシステムを構築するためにプロセス全體でユーザーの入力を信頼しないでください。

前者はコードが表現できない背景またはビジネスロジックを提供するため、「何をすべきか」ではなく「理由」コメントを使用することを優(yōu)先します。 2。コードによって明確に表現されているコンテンツの複製を避け、変數または関數の命名を改善することにより読みやすさを向上させます。 3. phpdocブロックコメントを使用して関數関數関數を説明し、意思決定の理由を説明し、コードの維持可能性を改善し、その後の開発時間を節(jié)約することに焦點を當てたインラインコメントを維持します。

コードが直感的でない場合（ビット操作や規(guī)則性など）、意図についてコメントする必要があります。 2。パブリック機能は、目的と暗黙の論理（休日のステータスに依存するなど）についてコメントする必要があります。 3. TODO/FIXMEを使用して、一時的な計畫またはTO項目（ハードコードされたAPIアドレスなど）をマークします。 4.外部アルゴリズムを引用する場合、ソース（StackOverFlowリンクなど）;注釈の中核は、數字を補うのではなく、理解のコストを削減することです。