Czy istnieje standardowy styl dokumentacji w PHP?

Question

Jestem nowy w rozwoju PHP i zastanawiam się, czy społeczność ma jakiekolwiek wytyczne dotyczące wbudowanej dokumentacji kodu za pomocą komentarzy. Uwielbiam coś takiego jak Python PEP 257, ale zadowalam się formatem używanym przez popularne narzędzie do wyodrębniania dokumentów, a nawet standardem dokumentacji popularnego produktu.

Answer 1

Najbardziej powszechnie stosowana forma dokumentacji API dla PHP jest phpDocumentor a.k.a. PHPDoc. Wiele IDE może również wyodrębnić informacje, aby ulepszyć wskazówki dotyczące automatycznego uzupełniania, korzystając z dokumentów API w stylu phpDocumentor.

Answer 2

Zastosowanie phpdoc (bardzo podobny do javadoc)

Answer 3

PHPDoc jest pierwszą rzeczą, która przychodzi do głowy, spojrzeć na http://www.phpdoc.org/

Answer 4

PEAR (PHP Extension and Application Repository) ma coding standards która obejmuje sample file użyciu PhpDocumentor, a także kilka innych przydatnych konwencje.

Answer 5

Styl phpdoc (phpDocumentor) jest wspólny. Używa ona DocComments zawierającego DocBlocks.

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

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

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

Tagi i adnotacje:

<?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