Question

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

我想知道答案，因为我正在研究一个PHP项目，我相信当它完成时，人们将查看源代码。我目前在评论中有一个//评论，但似乎缺乏评论。我见过人们使用块注释并添加@author等等，这是接受的语法吗？

感谢。

Answer 1

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

您可以找到一个好的起始参考here。

使用这种标准化的代码元数据标记方法的主要优点是，您可以使用PHPDocumentor等标准化工具自动生成文档like this。另一个是像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;

 }

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

2 个答案: