標準的な PHP 関数のドキュメントを作成するにはどうすればよいですか?

PHP 関数のドキュメントを作成する場合は、命名規則、@param、@return、@throws タグを使用したパラメーターの型、戻り値の型、例外型の指定、PSR-5 コメント ブロック標準の採用などの標準化された規則に従う必要があります。 。以下は、準拠したコメント ブロックの例です: /**ログインユーザー @param string $name ユーザー名 @param string $password パスワード @return bool ログインが成功したか @throws InvalidArgumentException $name または $password が空の場合*/function login(string $name, string $password): bool{// ...}

#標準化された PHP 関数ドキュメントの書き方

はじめに

命名規則

関数名は小文字で始まり、単語を区切るのにアンダースコアを使用する必要があります (例:
• my_function)。
PSR-2 命名規則に従い、クラスとメソッドにはキャメルケースの命名を使用します (例:
• MyFunction)。

@param タグ

• @param タグを使用して、関数パラメーターのタイプと説明を指定します。
• 例:

  /**
   * @param string $name 用户名
   * @param string $password 密码
   */
  function login(string $name, string $password)
  {
    // ...
  }

  ログイン後にコピー

@return タグ

使用
• @return タグは、戻り値の型と関数の説明を指定します。
• 例:

  /**
   * @return bool 登录是否成功
   */
  function login(string $name, string $password): bool
  {
    // ...
  }

  ログイン後にコピー

@throws タグ

• @throws# を使用します# # タグは、関数によってスローされる可能性のある例外のタイプと説明を指定します。
例:

• /**
   * @throws InvalidArgumentException 如果 $name 或 $password 为空
   */
  function login(string $name, string $password): bool
  {
    // ...
  }

  ログイン後にコピー

PSR-5に準拠した関数コメントの例コメントブロック標準 ：

/**
 * 登陆用户
 *
 * @param string $name 用户名
 * @param string $password 密码
 * @return bool 登录是否成功
 * @throws InvalidArgumentException 如果 $name 或 $password 为空
 */
function login(string $name, string $password): bool
{
    // ...
}

/**
 * 获取当前时间
 *
 * @return string 当前时间字符串
 */
function get_current_time(): string
{
    return date('Y-m-d H:i:s');
}

/**
 * 计算两个数字的和
 *
 * @param int $a 第一个数字
 * @param int $b 第二个数字
 * @return int 和
 */
function sum(int $a, int $b): int
{
    return $a + $b;
}