MVCフレームワークに適切なphpDocumentorタグはありますか？

Question

私がfooという名前のプロジェクトを持っており、モジュラーアーキテクチャでZendのフレームワークを使用していた場合、私はphpDocumentorの...

を使用するだけで新たなんだ：

モジュール -module_test -controller -indexController -views -indexView -モデル -index_model

どのphpdocタグを使用するとよいですか？

今私は

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

は、それが十分であろう（例えばindexController.php）と思っていますか？ 返信いただきありがとうございます:)

Answer 1

以下は、VIMのPHPDocumenterプラグインによって作成されたものです。私は長い間それを使用してきたと私はそれが十分だと思う。ちょうどfyi。

/** 
* 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} 
*/ 

Answer 2

Zend Frameworkには、インラインドキュメントに必要なものとして定義されているいくつかの標準があり、ガイドラインとして使用できます。すべてのZend Frameworkクラスがすべてのタグを使用するわけではないので、あなたの裁量でいくつかを省略することができます。

ZFドキュメントページのCoding Standards - Inline Documentationを参照してください。

ファイル

PHPコードを含むすべてのファイルは、最低限これらのphpDocumentorタグを含むファイルの先頭でのdocblockを持っている必要があります。

/** 
* 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タグを含むdocblockが必要です最低でも：

A description of the function 

All of the arguments 

All of the possible return values 

：

/** 
* 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 
*/ 

機能

すべての機能、オブジェクトのメソッドを含め、最低でも含まれているのdocblockを持っている必要があります