Оглавление

Создание комментариев в стиле Doc-блоков

Хотя создание комментариев в стиле Doc-блоков (DocBlock) и не является формальной частью ООП, этот метод широко используется при документировании классов. Помимо того что он служит своего рода стандартом, которым разработчики могут руководствоваться при написании кода, .он уже внедрен в наиболее популярные SDK (Software Development Kit — набор средств для разработки ПО), такие как Eclipse  и NetBeans , и будет использоваться для генерации сопроводительных комментариев к коду.

 
Doc-блоки определяются путем использования многострочных комментариев, в начале строк которых содержится дополнительная "звездочка".

 

/** 
 * Это простейший Doc-блок 
 */ 


Удобство Doc-блоков обусловлено возможностью использования меток, начинающихся символом @, сразу за которым следует имя метки и ее значение. Это позволяет разработчику указать имя автора сценария, лицензию для класса, информацию о свойстве или методе и любую другую полезную информацию.

 

Ниже приводится список наиболее часто используемых меток.
■   @author. Эта метка позволяет указать автора текущего элемента (каковым может быть класс, файл, метод или любой другой фрагмент кода). В одном и том же Doc-блоке можно использовать несколько меток @author, если автор не один. Формат использования: John Doe < j ohn. doe@email. com>.
■   @ copyright. Позволяет указать год регистрации авторских прав и имя их владельца для текущего элемента. Формат использования: 2010 имя_владельца_ лицензии.
■   @license. Ссылка на лицензию для текущего элемента. Формат использования: http://www.example.com/path/to/license.t3ct Название ^лицензии.
■   @var. Хранит тип и описание переменной или свойства класса. Формат использования: тип описание_элемента.
■   @param. Эта метка отображает тип и описание параметра функции или метода. Формат использования: тип $имя__элемента  описание_элемента.
■   @return. Эта метка предоставляет тип и описание значения, возвращаемого функцией или методом. Формат задания информации для этой метки следующий: тип описание_возвращаемого_элемента.

 
Ниже показан пример включения комментариев в класс с использованием Doc-блоков.

 

<?php 
/**
* Простой класс
*
* Это расширенное описание данного класса, которое может
* содержать сколько угодно строк. Оно не является обязательным,
* тогда как краткое описание требуется всегда.
*
* Кроме того, это описание может состоять из нескольких
* абзацев, если такое многословие оправдано.
*
* @author Jason Lengstorf <jason.lengstorf@ennuidesign.com>
* @copyright 2010 Ennui Design
* Glicense http://www.php.net/license/3_01.txt PHP License 3.01
*/
class SimpleClass 
{ 
    /** 
     * Общедоступная переменная 
     * 
     * @var string: хранит данные для класса
     */ 
    public $foo; 
 
    /** 
     * Устанавливает для $foo новое значение
     * при создании экземпляра класса
	 *
     * @param string $val: параметр класса
     * @return void 
     */ 
    public function __construct($val) 
    { 
        $this->foo = $val; 
    } 
 
    /** 
     * Перемножает два целых числа  
     * 
     * Принимает два целых числа и возвращает
     * их произведение. 
     * 
     * @param int $bat: сомножитель 
     * @param int $baz: сомножитель
     * @return int: произведение двух параметров 
     */ 
    public function bar($bat, $baz) 
    { 
        return $bat *$baz; 
    } 
} 
 
?> 
 

Даже беглого просмотра этого класса достаточно для того, чтобы преимущества Doc-блоков стали очевидными: в коде отсутствуют неясности, так что тот, кому придется с ним работать, сможет сразу взяться за дело, не теряя времени на догадки относительно того, какую роль играет тот или иной фрагмент кода.

 

Примечание. Более подробную информацию относительно Doc-блоков можно найти по адресу:
 http://ru.wikipedia.org/wiki/PHPDoc
Комментарии принадлежат их авторам. Мы не несем ответственности за их содержание.
Отправитель Нити