PHP関数ドキュメントの仕様の概要
PHP関数ドキュメント作成仕様には、必要なフィールドには、関数名、パラメーター（デフォルトパラメーターを含む）、返品値、例外が含まれる必要があります。オプションのフィールドには、説明、エイリアス、互換性、非難、バージョンの削除が含まれます。ライティングルールは、明確で簡潔な言語を強調し、Docblockアノテーション形式を使用し、ケースの例を介して関数の使用とタイププロンプトを示します。
必要なフィールド
- 関数名：CamelCaseを使用して名前が付けられた関数の一意の識別子。
- パラメーター：関数によって受け入れられたパラメーターのリスト、$ param1、$ param2など。
- デフォルトパラメーター：関数のパラメーターにデフォルト値がある場合、パラメーター名の後に= default_valueで指定します。
- 返品値：関数によって返される値のタイプ。
- 例外：関数がスローする可能性のある例外のリスト。
- 例：1つ以上のデモ機能で使用されるコードの例。
オプションのフィールド
- 説明：関数関数と用途の簡単な説明。
- エイリアス：関数のエイリアス。
- 互換性：関数によってサポートされるPHPバージョン。
- 非推奨：関数の非推奨PHPバージョン。
- 削除：PHPから削除された関数のバージョン。
ルールを書く
- 明確で簡潔な言語を使用して、時代遅れの用語を避けます。
- 開発者に機能がどのように機能するかを理解させるのに十分な情報を提供します。
- docblockアノテーション形式を使用します。
実用的なケース
/**
* 2つの数値の平均を計算しますします。
*
* @param float $ num1最初の番号* @param float $ num2 2番目の番号* @return float平均*/
関数平均（フロート$ num1、フロート$ num2）：フロート
{
return（$ num1 + $ num2） / 2;
}他のヒント
- コードスニペットを使用して、関数の使用を実証します。
- より多くの情報を提供するために、ドキュメント内の関連する機能またはクラスをリンクします。
- コードの読みやすさを改善するために、できる限りタイププロンプトを提供します。
- 正確さと一貫性を確保するために、定期的にドキュメントを確認してください。
