有人能解释一下@comments在这个PHP类中的使用吗

  • 本文关键字:PHP 能解释 @comments 一下 php
  • 更新时间 :
  • 英文 :


我试图找到一种在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方式处理数据库的好方法吗?(请查看上面的链接以获得想法)。

谢谢!

它主要用于处理phpDoc时。return或var或param前面的@将允许phpDoc服务为代码创建API文档。不管是否使用phpDoc,您都应该始终指定return、params和var类型。只是我的看法。

最新更新