PHPDoc
PHPDoc — это адаптация формата Javadoc для PHP языка программирования . Это все еще неофициальный стандарт комментирования PHP-кода, но он находится в процессе формализации. [1] Он позволяет использовать внешние генераторы документов, такие как phpDocumentor , который является стандартной реализацией де-факто. [1] для создания документации по API и помогает некоторым IDE, таким как Zend Studio , NetBeans , JetBrains PhpStorm , ActiveState Komodo Edit и IDE , PHPEdit и Aptana Studio, интерпретировать типы переменных и другие неоднозначности в свободно типизированном языке , а также обеспечивать улучшенное завершение кода , подсказку типов и отладка.
PHPDoc поддерживает документацию как объектно-ориентированного, так и процедурного кода.
13 августа 2013 года группа совместимости PHP Framework начала писать формальную спецификацию (PSR) для PHPDoc. [1]
Пример
[ редактировать ]/**
* Get all image nodes.
*
* @param \DOMNode $node The \DOMDocument instance
* @param boolean $strict If the document has to be valid
*
* @return \DOMNode
*/
public function getImageNodes(\DOMNode $node, $strict = true): \DOMNode
{
// ...
}
См. также
[ редактировать ]Ссылки
[ редактировать ]- ^ Jump up to: а б с PHP-FIG: Рабочий проект PSR — https://github.com/php-fig/fig-standards/blob/master/propose/phpdoc.md