在PHP文件中正确标记作者和项目名称

Question

我只是想知道什么是最容易接受的方式来表扬自己，并在文档开头（最好）描述整个包，以便其他查看代码的人有参考？

我想知道答案，因为我正在进行一个PHP项目，我相信当它完成后，人们会查看源代码。我目前在开头有一个//评论，但它似乎缺乏。我见过人们使用块注释和添加@author等等，这是公认的语法吗？

谢谢。

Answer 1

是的，带有块注释和标记（如@author和@copyright）的语法是标准化的，它被称为PHPDoc。

你可以在这里找到一个好的起点参考。

对代码元数据使用这种标准化标记方式的主要优点是，您可以使用标准化工具（如PHPDocumentor）自动生成这样的文档。另一个是，像PHPStorm这样的高级IDE可以解析文档块，以提供自动完成和其他代码完成功能，甚至智能重构工具。

Answer 2

您可以使用这种风格，它被称为PHPDoc风格。

/**
 *  return string of content between provided
 *  $from and $to positions.
 *  if $to is not provided $from will be considered              
 *  a string to remove.
 *
 * @param string $str string from select contents
 * @param string $from starting point for select contents
 * @param string $to ending point for select contents * 
 * @return string
 * @author 
 */
 function extractor($str,$from,$to)
 {
    $from_pos = strpos($str,$from);
    $from_pos = $from_pos + strlen($from);
    $to_pos   = strpos($str,$to,$from_pos);// to must be after from
    $return   = substr($str,$from_pos,$to_pos-$from_pos);
    unset($str,$from,$to,$from_pos,$to_pos );           
    return $return;
 }