Created
March 28, 2012 17:59
-
-
Save aminin/2228761 to your computer and use it in GitHub Desktop.
Пример применения докблоков
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?php | |
| /** | |
| * Событие с полезной нагрузкой | |
| * | |
| * PHP 5.3 | |
| * | |
| * Это докблок файла. | |
| * Если бы этого блока не было, phpDocumentor был бы недоволен. | |
| * Здесь могла быть упомянута лицензия MIT. | |
| * | |
| * @package MosWarBot | |
| * @author Антон Минин <anton.a.minin@gmail.com> | |
| * @link http://github.com/aminin/ | |
| */ | |
| namespace MosWarBot; | |
| use \Symfony\Component\EventDispatcher\Event as SymfonyEvent; | |
| /** | |
| * Событие с полезной нагрузкой | |
| * | |
| * PHP 5.3 | |
| * | |
| * Это докблок класса. | |
| * Если бы этого блока не было, phpDocumentor был бы недоволен. | |
| * Но, чем же он отличается от докблока файла? | |
| * | |
| * @package MosWarBot | |
| * @author Антон Минин <anton.a.minin@gmail.com> | |
| * @link http://github.com/aminin/ | |
| */ | |
| class Event extends SymfonyEvent | |
| { | |
| /** | |
| * Полезная нагрузка | |
| * | |
| * Иногда, в событии хочется передать что-то большее, чем просто его имя. | |
| * Корифеи Симфонии подсказывают, что для разных "полезных нагрузок" нужны | |
| * разные типы событий, но мне лень так делать. | |
| * | |
| * @todo победить в себе лодыря. | |
| * @var mixed | |
| */ | |
| protected $_payload; | |
| /**#@+ | |
| * Эта функция слишком элементарна, чтобы писать про неё докблок. | |
| */ | |
| public function __construct($payload = null) | |
| { | |
| $this->setPayload($payload); | |
| } | |
| public function getPayload() | |
| { | |
| return $this->_payload; | |
| } | |
| public function setPayload($payload) | |
| { | |
| $this->_payload = $payload; | |
| } | |
| /**#@-*/ | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment