有人可以解释在这个 PHP 类中使用 @ 注释吗？ [复制]

Question

我试图找到一种在 PHP 中处理数据库的 OO 方式，结果发现：https://github.com/adriengibrat/Simple-Database-PHP-Class

在尝试使用它之前，我正在阅读代码，试图准确了解正在做什么（到目前为止失败得很惨）。

一路上我看到了我不习惯看到的以“@”为前缀的 cmets。这是 IDE 会添加的东西，还是在类中评论事物的 OO 方式？以这个 sn-p 为例：

/**
 * Get and set default Db configurations
 * @uses   static::config
 * @param  string|array $key   [Optional] Name of configuration or hash array of configurations names / values
 * @param  mixed        $value [Optional] Value of the configuration
 * @return mixed        Configuration value(s), get all configurations when called without arguments
 */
static public function config ( $key = null, $value = null ) {
    if ( ! isset( $key ) )
        return static::$config;
    if ( isset( $value ) )
        return static::$config[ (string) $key ] = $value;
    if ( is_array( $key ) )
        return array_map( 'static::config', array_keys( (array) $key ), array_values( (array) $key ) );
    if ( isset( static::$config[ $key ] ) )
        return static::$config[ $key ];
}

有人能解释一下这些 cmets 的意义吗？

此外，虽然与我的问题无关，但任何人都可以评论这是否是一种以 OO 方式处理数据库的好方法？ （请查看上面的链接了解一下）。

谢谢！

Answer 1

它主要用于使用 phpDoc 时。 return 或 var 或 param 前面的 @ 将允许 phpDoc service 为您的代码创建 API 文档。无论是否使用 phpDoc，您都应该始终指定返回值、参数和 var 类型。只是我的看法。