Question

我是PHP开发的新手，我想知道社区是否有使用注释的代码内联文档的任何指南。我喜欢像Python PEP 257这样的东西，但我会选择一种流行的文档提取工具使用的格式，甚至是流行产品的文档标准。

Answer 1

PHP最广泛使用的API文档形式是phpDocumentor a.k.a. phpdoc。相当多的IDE也能够使用phpDocumentor样式API文档提取信息以改进自动完成提示。

Answer 2

使用phpdoc（非常类似于javadoc）

Answer 3

首先想到的是PHPdoc，请看一下http://www.phpdoc.org/

Answer 4

PEAR（PHP扩展和应用程序存储库）有coding standards，其中包含使用phpDocumentor的sample file，以及其他一些有用的约定。

Answer 5

phpdoc（phpDocumentor）风格很常见。它使用包含DocComments的DocBlocks。

<?php
/**
 * This is a DocBlock for a function.
 */
function associatedFunction()
{
}

<?php
/**
 * I belong to a file
 */

/**
 * I belong to a class
 */
class Def
{
}

标签和注释：

 <?php
 /**
  * A summary informing the user what the associated element does.
  *
  * A *description*, that can span multiple lines, to go _in-depth_ into the details of this element
  * and to provide some background information or textual references.
  *
  * @param string $myArgument With a *description* of this argument, these may also
  *    span multiple lines.
  *
  * @return void
  */
  function myFunction($myArgument)
  {
  }

Source

PHP中的文档是否有标准样式？

5 个答案: