是否有与C#summary标签等效的PHP?

时间:2012-04-03 12:07:49

标签: php usability

有没有提供文本编辑器摘要信息在自定义函数/类等的工具提示中,以及它们在编码时可以为标准库做的方式?

失败这是突出目的的标准方法,PHP中的函数/类所需的参数等。

2 个答案:

答案 0 :(得分:2)

查看PHPDocumentor

一个例子是:

/**
 * Set the data
 *
 * @access public
 * @param string $field
 * @param mixed $value
 */
public function __set($field, $value)
{
  $this->_data[$field] = $value;
}

/**
 * Get the data
 *
 * @access public
 * @param string $field
 * @return mixed
 */
public function __get($field)
{
  return isset($this->_data[$field]) ? $this->_data[$field] : NULL;
}

当评论自我解释时,您使用@access来显示方法的可见性(当然,如果要汇总的代码是方法),@param以显示每个参数,以及{ {1}}显示返回的数据类型。有许多不同的标签可以记录代码的许多不同方面。

答案 1 :(得分:1)

您可以使用PHPDoc标准让IDE为您提供有关功能的提示。

在函数声明之前,您可以:

/**
 * This is a DocBlock comment
 */
function foo(){
    //....
}

我在Netbeans中使用它,可以说它运行得很好。