Как по стандартам правильно оформлять шапку php файла?

Question

[Александр Владимирович]

имеется в виду Блок комментариев в заголовке

/* vim: set expandtab tabstop=4 softtabstop=4 shiftwidth=4: */
// +---------------------------------------------------------------------------+
// | PHP version 5.6.11                                                        |
// +---------------------------------------------------------------------------+
// | Copyright (c) 2004-2015                                                   |
// +---------------------------------------------------------------------------+
// | 23 июл 2015                                                               |
// | Класс - Iptv                                                        |
// +---------------------------------------------------------------------------+
// | Author: Alexander Polyanin <[e-mail]>                           |
// +---------------------------------------------------------------------------+
//
//

Answer 1

[Сергей Иванов]

ну примерно так, но не проще ли вынести все это в какой нибудь файл отдельный , чтобы в дальнейшем люди не сидели и не читали 20 строк ненужной информации?

Всегда считал и буду считать, что эта информация избыточна и абсолютно не нужна.

Comments

[Сергей Протько]

лучше так: PSR-2

[Сергей Протько]

По поводу избыточности - полностью согласен. Хотя иногда бывает полезно, когда люди тянут пару файликов из библиотеки и потом днем с огноем не сыщешь откуда они это раскапали. Благо ситуация чисто гипотетическая, у меня она возникает когда приходится убирать мусор за фронтэндщиками на старых проектах, где еще нет bower-а и т.д.

[Александр Владимирович]

Сергей Протько: Не вижу там никаких примеров шапок

[Сергей Протько]

Александр Владимирович: их там и не должно быть, шапки это чисто на ваше усмотрение и как хотите. Это не регламентируется нигде, ни в PhpDoc ни где-быто нибыло еще. И обычно это довольно избыточная штука.

[Сергей Иванов]

Александр Владимирович: Эти заголовки имеют смысл если проектом занимаются несколько человек. Либо это сторонняя библиотека. Во всех остальных случаях это на ваше усмотрение.

[Сергей Иванов]

Александр Владимирович: стандарта как не было так и не будет. В стандарте комментирования дальше всех по-моему ушел только java www.tutorialspoint.com/java/java_documentation.htm

Answer 2

[Сергей Протько]

по стандартам - никак.

в любом случае это обычно dock block через строчку после <?php, содержащее к какому пакету пренадлежит файл, информация об авторе + контактные данные а так же информация о лицензии.

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

Информация аля "tabstop=4" обычно пишется в файлики типа .editorconfig

Answer 3

[trevoga_su]

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

Программный код лучше комментируйте!