我想知道如何根据PEAR标准编写代码注释，用于' @return标签，用于php中的以下函数。
在阅读PEAR标准时，我了解到:
返回标记应该包含数据类型，然后是返回的数据:(这部分很清楚)
Description:按照约定，Description中的第一个名词是参数的数据类型。诸如"一个"、"一个"answers"那个"之类的文章。可以放在名词前面。描述应该以短语开头。如果需要进一步的描述，请在句子之后。
我的问题是:我如何为以下函数编写@return标记的描述，如果函数执行成功则返回true ?
function AUTOCODER_writeFile($filename, $code)
{
$handle = fopen($_POST['db']."/".$filename, "w");
fwrite($handle, $code);
fclose($handle);
return true;
}
正如您链接的页面所指定的，docblock注释用于使用phpDocumentor生成PEAR文档。
你的函数的最小docblock注释应该是这样的:
/**
* @param string $filename
* @param string $code
* @return bool
*/
function AUTOCODER_writeFile($filename, $code)
{
$handle = fopen($_POST['db']."/".$filename, "w");
fwrite($handle, $code);
fclose($handle);
return true;
}
将string替换为$code的正确类型，如果它不是字符串;如果您的代码以这种方式工作，它只能是字符串或数字(int或float)。
有一个有用的文档块，在每个参数的名字后面描述其目的，并放一行描述函数的功能。比如:
/**
* Store a code into a file
*
* @param string $filename the name of the file
* @param string $code the value to store
* @return bool
*/
你可以在phpDocumentor的文档中找到更多关于如何编写代码的信息。它是PHP文档的事实上的标准;许多ide都理解它，并使用它来帮助您在不运行代码的情况下进行提示和错误检测。