Warning: file_get_contents(/data/phpspider/zhask/data//catemap/1/php/261.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
有人能解释一下@comments在这个PHP类中的用法吗?_Php - Fatal编程技术网

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

有人能解释一下@comments在这个PHP类中的用法吗?,php,Php,我试图找到一种用PHP处理数据库的OO方法,遇到了以下问题: 在尝试使用它之前,我正在通读代码,试图准确地理解正在做什么(到目前为止失败得很惨) 一路上,我看到了我不习惯看到的以“@”为前缀的评论。这是IDE附加的东西还是在类中注释事物的OO方式?请看以下代码段,例如: /** * Get and set default Db configurations * @uses static::config * @param string|array $key [Optional] N

我试图找到一种用PHP处理数据库的OO方法,遇到了以下问题:

在尝试使用它之前,我正在通读代码,试图准确地理解正在做什么(到目前为止失败得很惨)

一路上,我看到了我不习惯看到的以“@”为前缀的评论。这是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 ];
}
有人能解释一下这些评论的意义吗

另外,尽管与我的问题无关,但有人能评论一下这是否是一种以面向对象的方式处理数据库的好方法吗?(请查看上面的链接以获得想法)


谢谢

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

实际上有一个问题,你可以看一下。phpDocumentor doc blocks…实际上,它只是一种混乱的方式,可以在脚本的头部显示函数正在执行的操作,而不必在整个脚本中使用普通的伪代码来解释操作。假设您已经在脚本世界中工作了一段时间,可以浏览正在使用的逻辑,而无需进行深入的评论。@WASasquatch不是,乱七八糟。。。“机器可读”。用于从代码生成API文档,可以将其格式化为HTML或其他有用的内容。谢谢大家,我现在就来看看重复的主题。同时,有人对我发现的这个数据库类有什么看法吗?它只是用来发布你的代码,比如git等。如果你不打算使用这些服务,那么让其他人更容易地重新发布你的代码,并对其逻辑进行完整的解释是没有意义的。这就是为什么商业产品不指定PHP类型提示的原因。这样做,在不发布代码的情况下,他们就可以很容易地宣称自己的代码是基于github或其他地方构建的,而您却没有。