Ich bin neu in der PHP-Entwicklung, und ich frage mich, ob die Community Richtlinien für die Inline-Dokumentation von Code mit Kommentaren hat. Ich würde etwas wie Pythons PEP 257 lieben, aber ich würde mich mit einem Format begnügen, das von einem beliebten Dokumententnahmewerkzeug oder sogar dem Dokumentationsstandard eines beliebten Produkts verwendet wird.Gibt es einen Standardstil für die Dokumentation in PHP?
Die am weitesten verbreitete Form der API-Dokumentation für PHP ist phpDocumentor auch bekannt als phpdoc. Eine ganze Reihe von IDEs ist auch in der Lage, Informationen zu extrahieren, um Hinweise zur automatischen Vervollständigung mithilfe von phpDocumentor-API-Dokumenten zu verbessern.
Verwenden phpdoc (sehr ähnlich javadoc)
PHPDoc ist das erste, was in den Sinn kommt, werfen Sie einen Blick auf http://www.phpdoc.org/
PEAR (PHP-Erweiterung und Application Repository) hat coding standards, die ein sample file mit phpDocumentor enthält, sowie einige andere nützliche Konventionen.
Der phpdoc (phpDocumentor) Stil ist üblich. Es verwendet DocComments mit DocBlocks.
<?php
/**
* This is a DocBlock for a function.
*/
function associatedFunction()
{
}
<?php
/**
* I belong to a file
*/
/**
* I belong to a class
*/
class Def
{
}
Stichwörter und Anmerkungen:
<?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)
{
}