Question

是否有最佳实践方法来记录PHP类使用哪些外部常量？

例如，我有一个将数据记录到文本文件的类。该类创建一个文件并将其放入目录中。该目录的路径是常量APP_LOG_PATH。我应该如何记录我的代码，以便有人可以快速查看PHP类，并且知道需要在调用代码的某处定义APP_LOG_PATH。类似的东西：

/**
* Write to file
*
* @depends_on APP_LOG_PATH
* @param string The file name
* @param string The content to write
*/
static public function write_to_file($filename, $content){
    file_put_contents(APP_LOG_PATH . $filename, $content);
}

Answer 1

您可以考虑使用@uses标记。从描述：

@uses标签可用于记录任何元素（全局变量，包含，页面，类，函数，定义，方法，变量）

接着说它将尝试在正在使用的项目上创建反向链接，因此文档可以显示将使用它的函数/方法。

Answer 2

一种方法是使用依赖注入，然后您可以在注入函数/参数上记录它。另一种方法是在define的docblock上记录常量，这是phpdoc: What's the proper way to document a constant中引用的解决方案

phpDoc方法列出一个类使用的外部常量？

2 个答案: