Soy nuevo en el desarrollo de PHP, y me pregunto si la comunidad tiene alguna guía para la documentación en línea del código mediante comentarios. Me encantaría algo como el PEP 257 de Python, pero me conformaría con un formato utilizado por una popular herramienta de extracción de documentos, o incluso el estándar de documentación de un producto popular.¿Existe un estilo estándar para la documentación en PHP?
La forma más ampliamente utilizada de la documentación de la API para PHP es phpDocumentor phpdoc alias. Muchos IDE también pueden extraer información para mejorar los consejos de autocompletado utilizando los documentos de la API de estilo phpDocumentor.
Uso phpdoc (muy similar a javadoc)
PHPdoc es la primera cosa que viene a la mente, echar un vistazo a http://www.phpdoc.org/
PEAR (PHP Extensión y Application Repository) tiene coding standards que incluye un sample file usando phpDocumentor, así como algunas otras convenciones útiles.
El estilo phpdoc (phpDocumentor) es común. Utiliza DocComments que contiene DocBlocks.
<?php
/**
* This is a DocBlock for a function.
*/
function associatedFunction()
{
}
<?php
/**
* I belong to a file
*/
/**
* I belong to a class
*/
class Def
{
}
etiquetas y anotaciones:
<?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)
{
}