Подходящие теги phpDocumentor для инфраструктуры MVC? - PullRequest
Новая
       11

Подходящие теги phpDocumentor для инфраструктуры MVC?

0 голосов
/ 08 декабря 2011

Я просто новичок в использовании PhpDocumentor ...

Если у меня есть проект с именем foo и я использую Zend Framework в модульной архитектуре:

Модули -module_test -controller -indexController -views -indexView -models -index_model

Какие теги phpdoc было бы полезно использовать?

Сейчас я думаю (например, indexController.php) 

/**
 * @author some author
 * @category module_test
 * @package controllers
 * @copyright http://rainbowriders.dk Rainbow Riders ApS
 * @version 1.0
 */

будет ли этого достаточно?Большое спасибо за любой ответ:)

Ответы [ 2 ]

2 голосов
/ 09 декабря 2011

Zend Framework имеет некоторые стандарты, которые он определяет как необходимые для встроенной документации, поэтому вы можете использовать их в качестве руководства. Не все классы Zend Framework даже используют все теги, поэтому используйте их по своему усмотрению.

См. Стандарты кодирования - встроенная документация на странице документов ZF.

Файлы

Каждый файл, содержащий код PHP, должен иметь докблок в верхней части файла, который содержит как минимум следующие теги phpDocumentor: 

/**
* Short description for file
*
* Long description for file (if any)...
*
* LICENSE: Some license information
*
* @category   Zend
* @package    Zend_Magic
* @subpackage Wand
* @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @license    http://framework.zend.com/license   BSD License
* @version    $Id:$
* @link       http://framework.zend.com/package/PackageName
* @since      File available since Release 1.5.0
*/

Классы

Каждый класс должен иметь докблок, который содержит как минимум следующие теги phpDocumentor: 

/**
* Short description for class
*
* Long description for class (if any)...
*
* @category   Zend
* @package    Zend_Magic
* @subpackage Wand
* @copyright  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @license    http://framework.zend.com/license   BSD License
* @version    Release: @package_version@
* @link       http://framework.zend.com/package/PackageName
* @since      Class available since Release 1.5.0
* @deprecated Class deprecated in Release 2.0.0
*/

Функция

Каждая функция, включая методы объекта, должна иметь докблок, который содержит как минимум: 

A description of the function

All of the arguments

All of the possible return values
0 голосов
/ 08 декабря 2011

Следующее было создано плагином PHPDocumenter для VIM. Я давно им пользуюсь и думаю, что этого вполне достаточно. Просто к вашему сведению. 

/**
 * Class name 
 * 
 * @uses parent class
 * @package 
 * @version $id$
 * @copyright 1997-2005 The PHP Group
 * @author my name <my@php.net> 
 * @license PHP Version 3.0 {@link http://www.php.net/license/3_0.txt}
 */
...