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，我只有一些模型和控制器。在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";
}

Answer 2

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

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

您可以在phpDocumentor指南here

中找到问题的答案等

如何使用phpDocumentor for CodeIgniter

2 个答案: