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

Question

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

Answer 1

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

Answer 2

Использование phpdoc (очень похож на Javadoc)

Answer 3

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

Answer 4

PEAR (PHP Extension и Application Repository) имеет coding standards который включает в себя sample file использованием PhpDocumentor, а также некоторые другие полезные соглашения.

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