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

Question

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

我想知道答案，因为我正在从事一个 PHP 项目，我相信当它完成后人们会查看源代码。我目前//在一开始就有评论，但似乎缺乏。我见过人们使用块注释并添加 a@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;

 }