是否有一种最佳实践方法来记录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);
}
您可以考虑使用@uses标记
@uses标记可用于记录任何元素(全局变量、include、page、class、function、define、method、variable)
它接着说,它将尝试在正在使用的项目上创建一个反向链接,这样文档就可以显示将使用它的功能/方法。
一种方法是使用依赖项注入,然后可以将其记录在注入函数/参数中。另一种方法是在define的docblock中记录常量,这是phpdoc:What';这是记录常量的正确方法