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

Question

Я всегда видел эти комментарии заголовков в 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
 */

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

Answer 1

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

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

API отражения PHP

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

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

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

Answer 2

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

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

Answer 3

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

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

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

Answer 4

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