Говорят, что создание сайта - очень длительный и трудоемкий процесс. Мы скажем - НЕТ! Ведь с новыми технологиями, такими как HTML5, CSS3, PHP и MySql можно быстро и легко научиться создавать сайты любой сложности.
Два сумасшедших веб-мастера покажут где что лежит и как этим пользоваться.
Авторизация
Новый
Забыл
Пожалуйста, заполните поля выше. Это нужно сделать обязательно, иначе ничего не получится.
PHP Статейки /

ООП в PHP 5 для начинающих. Часть 3-ая. Правила комментирования классов.

  • Четверг, 11 ноября 2011, 18:54 |
  • Автор: fiamma |
  • Просмотров: 5710 |
  • Комментарии: 1 |
  • В закладки:
"DocBlock" - это неофициальный набор правил для комментирования классов и входящих в класс методов. Хотя данные правила и не являются обязательными, применение их помогает другим разработчикам понять для чего нужна та или иная функция.

ООП в PHP5: Часть 1-ая | Часть 2-ая | Часть 4-ая

Именно этим стандартом комментирования руководствуются разработчики программного обеспечения, такие как Eclipse и NetBeans.

ООП подход в PHP 5 для начинающих. Часть 3-ая. Правила комментирования классов.

Для того, чтобы начать использовать данный стандарт комментирования, рассмотрим небольшой пример блока комментарием:
/**
* This is a very basic DocBlock
*/


С появлением DocBlocks, появилась возможность использования различных меток, которые начинаются с символа "@" сразу после имени тега. DocBlock теги позволяют разработчикам определять авторов скрипта, лицензию на класс, метод или свойство, и другая полезная информация.

Наиболее распространенными тегами являются:
* @author: автор текущего файла, метода либо другого куска кода. Если авторов несколько, то они просто перечисляются. Пример оформления: Kisten Alex .
* @copyright: Год создания и полное имя разработчика. Пример оформления: 2010 KnK Corp.
* @license: Ссылка на лицензию, по которой распространяется данный скрипт. Пример оформления:
http://www.example.com/path/to/license.txt License Name.
* @var: Метка для указания описания переменных, которые используется в данном классе.
* @param: Эта пометка показывает, тип и описание параметров функции или метода. Пример оформления: $element_name element description.
* @return: Метка для указания возвращаемых значений функции.


Пример класса, комментированного стандартом DocBlock:
<?php

/**
* A simple class
*
* This is the long description for this class,
* which can span as many lines as needed. It is
* not required, whereas the short description is
* necessary.
*
* It can also span multiple paragraphs if the
* description merits that much verbiage.
*
* @author Jason Lengstorf <jason.lengstorf@ennuidesign.com>
* @copyright 2010 Ennui Design
* @license http://www.php.net/license/3_01.txt PHP License 3.01
*/
class SimpleClass
{
    /**
     * A public variable
     *
     * @var string stores data for the class
     */
    public $foo;

    /**
     * Sets $foo to a new value upon class instantiation
     *
     * @param string $val a value required for the class
     * @return void
     */
    public function __construct($val)
    {
        $this->foo = $val;
    }

    /**
     * Multiplies two integers
     *
     * Accepts a pair of integers and returns the
     * product of the two.
     *
     * @param int $bat a number to be multiplied
     * @param int $baz a number to be multiplied
     * @return int the product of the two parameters
     */
    public function bar($bat, $baz)
    {
        return $bat * $baz;
    }
}

?>

Если вы попробовали разобраться в написанном самостоятельно, тогда преимущества данного стандарта становятся для вас очевидны: каждый кусочек кода описан и понятен разработчику. Он уже знает за что отвечает данный кусочек кода и какие данные возвращает функция.

Ознакомьтесь с подсветкой синтаксиса для DLE 9.0.
  • Пишет: Marlien (Гости) |
  • Сообщений: 0 |
  • 20 сентября, 07:09
  • #1
Holy concise data bamtan. Lol!
Добавить комментарий