2

我已经构建了一个相当广泛的 Web 应用程序，并且正在查看 CodeIgniter (CI) 的样式指南以了解如何进行注释。对于类和方法，它有这样的东西：

/** 
* Super Class 
* 
* @package Package Name 
* @subpackage Subpackage 
* @category Category 
* @author Author Name 
* @link http://example.com 
*/ 

class Super_class {}

/** 
* Encodes string for use in XML 
* 
* @access public 
* @param string 
* @return string 
*/ 

function xml_encode($str){}

这很好，但是我不知道要为这些选项填写什么。我真的没有@package，我只有一些模型和控制器。在 Java 中，我可能会使用包来保证安全性，但在 CI 中不会，它只是 MVC。例如，我总是有诸如 project_mode、projects (controller) 和 add_project_view.php 之类的东西。

还有@category 的格式是什么？phpDocumentor 文档说，“@category 标签用于将包组组织在一起”。再次，没有包裹！

其次，方法中的参数呢？有时我有两个字符串和一个数组或一个整数和一个数组，@param 的格式是什么？

谢谢，

4

2 回答 2

3

包、子包和类别用于更好地在逻辑上构建代码。您拥有的每个项目/代码文件都不需要它。

另一方面，定义方法中的参数非常有用，因为我们需要在阅读文档时知道它们是什么，因为我们需要在代码中调用这些方法时传递它们。

一个样本会是这样的：

/**
 * Sample function
 * @param string $param1 name of person
 * @param integer $param2 age of person 
 * @return string 
 */
function person($name, $age)
{
    return "$name is $age years old";
}
于 2012-09-26T17:11:59.567 回答
0

@package 只能用于记录过程页面或类。

包用于帮助您对相关元素进行逻辑分组。您编写类来将相关的函数和数据组合在一起，而 phpDocumentor 将文件的内容（函数、定义和包含）表示为“过程页面”。包用于将类和过程页面组合在一起，其方式与目录将相关文件组合在一起的方式相同。

您可以在此处的 phpDocumentor 指南中找到问题的答案和更多信息

于 2012-09-26T18:01:57.630 回答