Что означают эти комментарии

@izcian · Регистрация: 28.08.2012

Author24 — интернет-сервис помощи студентам

Иногда в комментариях например к классам встречаю вот такое:

PHP

var $basicPrice = 0;
    /**
     * Label for basic entry - if not free
     *
     * @var string
     */
    var $basicPriceLabel = '';
    /**
     * enable/disable cache
     *
     * @var boolean
     */
    var $cacheEnabled = false;
    /**
     * caceh lifetime
     *
     * @var integer
     */
    var $cacheLifetime = 0;
    /**
     * enable/disable cache
     *
     * @var boolean
     */

Я понимаю что означают они, просто любопытно. Зачем пишется собака? И зачем пишется что это стринг или булево значение если по коду и так ясно?

@AndreyDyakonov · 03.06.2013, 21:46

поскольку стандарты php никто не желает соблюдать, даже PSR.. то заморачиваться не стоит. Это какой-то формат оформления кода, вы можете придумать свой.. А пока не будет введено соблюдение стандартов на уровне интерпретатора... делайте что хотите и наплюйте на других

Изучайте лучше общие паттерны, да корпоративные стандарты конторы где вы работаете

@izcian · 04.06.2013, 08:54 **[ТС]**

))) Я просто думал, а вдруг это то же где-то описано, типа негласного правила (Вроде называть классы -отдельное слово с большой буквы), как то так...

@malframe · 04.06.2013, 09:52

Это формат оформления комментариев phpDocumentor. Представлено, кстати, очень сжато, там куча директив ещё есть. Предназначено это для создания оффлайн-документации по веб-проекту, т.е. документация создаётся прямо из кода, базируясь на указанных комментариях. Более подробно можете почитать здесь.

@AndreyDyakonov 122 / 120 / 7 Регистрация: 21.04.2013 Сообщений: 615
	03.06.2013, 21:46	2
	поскольку стандарты php никто не желает соблюдать, даже PSR.. то заморачиваться не стоит. Это какой-то формат оформления кода, вы можете придумать свой.. А пока не будет введено соблюдение стандартов на уровне интерпретатора... делайте что хотите и наплюйте на других Изучайте лучше общие паттерны, да корпоративные стандарты конторы где вы работаете 1

@izcian 2 / 2 / 0 Регистрация: 28.08.2012 Сообщений: 115
	04.06.2013, 08:54 [ТС]	3
	))) Я просто думал, а вдруг это то же где-то описано, типа негласного правила (Вроде называть классы -отдельное слово с большой буквы), как то так... 0

@malframe 9 / 9 / 4 Регистрация: 11.05.2013 Сообщений: 110
	04.06.2013, 09:52	4
	Это формат оформления комментариев phpDocumentor. Представлено, кстати, очень сжато, там куча директив ещё есть. Предназначено это для создания оффлайн-документации по веб-проекту, т.е. документация создаётся прямо из кода, базируясь на указанных комментариях. Более подробно можете почитать здесь. 0