高效地描述PHP函数

如何描述PHP函数的参数和返回类型（getter/setter）？

我需要告诉我的主持人返回类型，并列出每个函数的参数。 我有数百个函数，所以这成了一个问题，因为我需要为每一个修订版都这样做

我现在使用以下程序

ack grep“function”>/tmp/functions

2.在Vim中：

• %s/\d//g，%s/{//，%s/:///g

• `%s/*.php/\U&/
• 然后将大写文件名放在每个文件的函数列表的开头
• 将函数放入一个文件，将参数放入另一个文件，以便行号匹配
• 创建第三个文件，在其中为相应行编写

  setter

  或

  getter

paste-d“&”/tmp/{函数、函数参数、函数类型}

将LaTeX格式添加到每个文件的每个函数集

使用类似于

基本上，您可以向代码中添加特殊注释：

/**
 * A sample function docblock
 * @global string document the fact that this function uses $_myvar
 * @staticvar integer $staticvar this is actually what is returned
 * @param string $param1 name to declare
 * @param string $param2 value of the name
 * @return integer 
 */
function firstFunc($param1, $param2 = 'optional') {
    static $staticvar = 7;
    global $_myvar;

    return $staticvar;
}

它会自动为它生成HTML文档

基本上，这背后的想法是让程序员的生活更轻松，并允许编写内嵌API文档，而无需花费大量时间

有些IDE也理解这一点，并在您使用时显示文档。例如，函数：

/** Retrieve the action key
 * @return string
 */
function isValid($value) {
  ....
}

在Zend studio中显示：

---

特别是如果您使用这样的IDE（除Zend之外还有其他人这样做），您可能会发现自己很自然地记录了每个函数和参数，因为它在编码时对您有所帮助。

phpdoc。以添加两个数字并返回结果的求和函数为例：

/**
 * Adds up two int numbers
 * @param int $x the first number to add
 * @param int $y the second number to add
 * @return int the result of the operation
 */
 function my_sum ($x, $y)
 {
     return $x+$y;
 }

---

我在一个文件中有许多函数。如果我将注释块放在每个函数的开头，这样我就不需要将函数放在单独的文件中，这是否有效？是的。您还可以注释变量、类和定义。