Кодты документтегіздеу

PHPDoc

PHPDoc PHP кодын түсініктемелу әдісіді айту үшін пайдаланылатын ішкі стандарт. тегтердің жатты мәні мен мисалдар тізімін PHPDoc құжатында таба аласыз.

Төменде бір сыныпты жеке өрістерімен документтегіздеу міндеттілігін көрейік;

<?php
/**
 * @author Аты <a.name@example.com>
 * @link https://www.phpdoc.org/docs/latest/index.html
 */
class DateTimeHelper
{
    /**
     * @param mixed $anything \DateTime объектына айналдыратын көшірме боларында не болмаса
     *
     * @throws \InvalidArgumentException
     *
     * @return \DateTime
     */
    public function dateTimeFromAnything($anything)
    {
        $type = gettype($anything);

        switch ($type) {
            // \DateTime объектына айналдыратын көшірме болары
        }

        throw new \InvalidArgumentException(
            "Түрі '{$type}' болатын параметрді \DateTime объектына айналдырату сәтсіз болды"
        );
    }

    /**
     * @param mixed $date \DateTime объектына айналдыратын көшірме боларында не болмаса
     *
     * @return void
     */
    public function printISO8601Date($date)
    {
        echo $this->dateTimeFromAnything($date)->format('c');
    }

    /**
     * @param mixed $date \DateTime объектына айналдыратын көшірме боларында не болмаса
     */
    public function printRFC2822Date($date)
    {
        echo $this->dateTimeFromAnything($date)->format('r');
    }
}

Сыныптың барлығы үшін бағдарламаны анықтау үшін @author тегі мен @link тегі бар. @author тегі кодты жасаушыны анықтау үшін пайдаланылады және бірнеше жасаушыларды анықтау үшін қайталанады. @link тегі кодпен веб-сайт арасында байланыс болатын веб-сайтқа сілтеме жасау үшін пайдаланылады.

Сынып ішінде бірінші өтініште параметрді өтінішке жататын түрі, атауы мен сипаттамасын анықтау үшін @param тегі бар. Сонымен қатар, олдағы қайталанатын тіпті, @return мен @throws тегтері бар, осында өтінішті беру түрі мен болатын боларды анықтау үшін.

Екінші және үшінші өтініштер өте ұсын болып табылады, жатталатын және жатталатын екінші және үшінші өтініштердің doc блоктарының арасында @param тегі бар. Екінші және үшінші өтініштердің doc блоктарының маңызды айырмашылығы @return тегінің қосу/жою мүмкіндігіні көрсету. @return void нақты мәлімет болмайды деп айтуында бізге хабарлама бар; тарихи шолу @return void ұсынбаса, сонымен қатар (қайтарым табылмаса) нәтиже барлық іс-шараларды бірге көздейді.