如何为 CodeIgniter 使用 phpDocumentor答案

【问题标题】：How to use phpDocumentor for CodeIgniter如何为 CodeIgniter 使用 phpDocumentor
【发布时间】：2012-09-18 09:08:07
【问题描述】：

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

/** 
* 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 的格式是什么？

谢谢，

【问题讨论】：

标签： php codeigniter documentation phpdoc

【解决方案1】：

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

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

示例如下：

/**
 * 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";
}

【讨论】：

感谢您对参数的帮助。

【解决方案2】：

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

包用于帮助您对相关元素进行逻辑分组。你编写类以将相关的功能和数据组合在一起，以及 phpDocumentor 表示文件的内容（函数、定义、并包括）作为“程序页面”。一个包用于分组以相同的方式将类和程序页面放在一起目录将相关文件组合在一起。

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

【讨论】：

（我确实在我的原始帖子中引用了该指南。）根据这里的解释，我会说示例包是模型或控制器？
是的，对于 MVC 应用程序来说，一个好的基本“包”结构是模型、控制器和视图。 “包”分组标签仅用于根据您希望它们在文档中呈现的方式对事物进行逻辑分组。它们与代码执行无关，除非您选择基于此对齐包成员。这个标签早于命名空间，它是在 PHP 5.3 中添加的，因此它是以任何方式“组织”您的文档的唯一方法。