Формат комментариев PHP: автоматически сгенерированный или созданный пользователем?

Я всегда видел эти комментарии заголовков в php и часто задавался вопросом, использовалось ли какое-то программное обеспечение для их настройки? Кажется, я припоминаю JavaDoc или что-то в этом роде? Но я не уверен, что это автоматически генерируется? Или это просто какой-то стандарт документации?

Пример ниже взят из CodeIgniter:

/**
 * CodeIgniter
 *
 * An open source application development framework for PHP 4.3.2 or newer
 *
 * @package     CodeIgniter
 * @author      ExpressionEngine Dev Team
 * @copyright   Copyright (c) 2008, EllisLab, Inc.
 * @license     http://codeigniter.com/user_guide/license.html
 * @link        http://codeigniter.com
 * @since       Version 1.0
 * @filesource
 */

Я действительно хотел бы улучшить свои комментарии, и я чувствую, что это было бы отличной формой для моих проектов.


php formatting documentation
person Jakub    schedule 11.09.2009    source источник

Ответы (4)


arrow_upward
3
arrow_downward

Это phpDoc, который используется некоторыми фреймворками с отражением для динамического понимания и использования классов (самим кодом).

IDE также будут использовать его для автозаполнения, отображения аргументов функций и т. д. Полезно знать, предоставляет ли ваша IDE эти функции для используемого вами фреймворка, но не для кода, который вы пишете.

PHP Reflection API

Расширение Zend Framework (включая DocBlocks)

Руководство по комментариям CodeIgniter (использование DocBlock "... чтобы их могли подобрать IDE")

Описание DocBlock на phpdoc.org (ссылка из CI руководство по стилю)

person Tim Lytle    schedule 11.09.2009
comment
Добавлено несколько ссылок на примеры/документацию. - person Tim Lytle; 11.09.2009

arrow_upward
1
arrow_downward

Эти комментарии соответствуют стандарту phpdoc и могут использоваться для автоматического создания документации для вашего кода. Вы можете увидеть пример такой документации здесь.

Хотя в некоторых IDE есть поддержка, облегчающая их написание, фактический контент пишется программистами от руки.

person michaelk    schedule 11.09.2009

arrow_upward
1
arrow_downward

Некоторые IDE могут вставлять его автоматически, но люди часто просто вводят его.

Для PHP это PHP Documentor, вы можете увидеть краткое руководство здесь.

Это просканирует ваш исходный код и создаст документацию на основе ваших комментариев к вашим файлам, классам и функциям.

person dprevite    schedule 11.09.2009

arrow_upward
-1
arrow_downward

Это JavaDoc, и он, вероятно, автоматически генерируется IDE.

person zzandy    schedule 11.09.2009