Существует стандартный стиль для документации на PHP?

Я новичок в разработке PHP, и мне интересно, есть ли у сообщества какие-либо рекомендации по встроенной документации кода с использованием комментариев. Мне бы понравилось что-то вроде Python PEP 257, но я бы согласился на формат, используемый популярным инструментом для извлечения документов или даже стандартом документации популярного продукта.

Ответы

Ответ 1

Наиболее широко используемой формой документации API для PHP является phpDocumentor a.k.a. phpdoc. Довольно много IDE также могут извлекать информацию, чтобы улучшить подсказки автозаполнения, используя документы API стиля phpDocumentor.

Ответ 2

Используйте phpdoc (очень похоже на javadoc)

Ответ 3

PHPdoc - это первое, что приходит на ум, посмотрите http://www.phpdoc.org/

Ответ 4

PEAR (репозиторий расширений и приложений PHP) имеет стандарты кодирования, которые включают образец файла с использованием phpDocumentor, а также некоторые другие полезные соглашения.

Ответ 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)
  {
  }

Источник