Sono nuovo allo sviluppo di PHP e mi chiedo se la community abbia delle linee guida per la documentazione inline del codice usando i commenti. Mi piacerebbe qualcosa di simile a Python PEP 257, ma mi accontento di un formato utilizzato da un popolare strumento di estrazione dei documenti, o anche lo standard di documentazione di un prodotto popolare.Esiste uno stile standard per la documentazione in PHP?
La forma più diffusa di documentazione API per PHP è phpDocumentor PHPDoc pseudonimo. Un sacco di IDE sono anche in grado di estrarre informazioni per migliorare i suggerimenti di completamento automatico usando i documenti API in stile phpDocumentor.
Uso phpdoc (molto simile a javadoc)
PHPDoc è la prima cosa che viene in mente, dare un'occhiata a http://www.phpdoc.org/
PEAR (PHP Extension and Application Repository) ha coding standards che include un sample file utilizzando phpDocumentor, così come alcune altre convenzioni utili.
Lo stile phpdoc (phpDocumentor) è comune. Utilizza DocComments contenente DocBlocks.
<?php
/**
* This is a DocBlock for a function.
*/
function associatedFunction()
{
}
<?php
/**
* I belong to a file
*/
/**
* I belong to a class
*/
class Def
{
}
Tag e annotazioni:
<?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)
{
}