Question

我试图在PHP中找到一种处理数据库的OO方式，并且遇到了这样的问题：https://github.com/adriengibrat/Simple-Database-PHP-Class

在尝试使用它之前，我正在阅读代码，试图准确理解正在做什么（并且到目前为止失败得非常糟糕）。

在此过程中，我看到以“@”为前缀的评论，我不习惯看到。这是比IDE更多的东西还是在类中评论事物的OO方式？请看这个代码段：

/**
 * 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 ];
}

有人可以解释这些评论的重要性吗？

此外，虽然与我的问题无关，但是否有人能够评论这是否是以OO方式处理数据库的好方法？（看看上面的链接以获得一个想法）。

谢谢！

Answer 1

它主要用于处理phpDoc时。返回或var或param前面的@将允许phpDoc service为您的代码创建API文档。尽管如此，使用phpDoc还是应该总是指定return，params和var类型。只是我的意见。

有人可以解释在这个PHP类中使用@ comments吗？

1 个答案: