php - 如何将 phpDocumentor 用于 CodeIgniter

Question

我已经构建了一个相当广泛的 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，我只有一些模型和 Controller 。在 Java 中，我可能会使用包来保证安全，但在 CI 中不会，它只是 MVC。例如，我总是有诸如project_mode、projects(controller)和add_project_view.php之类的东西。

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

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

谢谢

Answer 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";
}