Zend Frameworkのコードの書類のスタイル

Question

私は繰り返し情報に2ブロックのコメントがあるのだろうと思っていました。誰かが答えを知っていますか？

/** 
* Zend Framework 
* 
* LICENSE 
* 
* This source file is subject to the new BSD license that is bundled 
* with this package in the file LICENSE.txt. 
* It is also available through the world-wide-web at this URL: 
* http://framework.zend.com/license/new-bsd 
* If you did not receive a copy of the license and are unable to 
* obtain it through the world-wide-web, please send an email 
* to license@zend.com so we can send you a copy immediately. 
* 
* @category Zend 
* @package Zend_Controller 
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com) 
* @license http://framework.zend.com/license/new-bsd  New BSD License 
* @version $Id: Action.php 23775 2011-03-01 17:25:24Z ralph $ 
*/ 

/** 
* @see Zend_Controller_Action_HelperBroker 
*/ 
require_once 'Zend/Controller/Action/HelperBroker.php'; 

/** 
* @see Zend_Controller_Action_Interface 
*/ 
require_once 'Zend/Controller/Action/Interface.php'; 

/** 
* @see Zend_Controller_Front 
*/ 
require_once 'Zend/Controller/Front.php'; 

/** 
* @category Zend 
* @package Zend_Controller 
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com) 
* @license http://framework.zend.com/license/new-bsd  New BSD License 
*/ 
abstract class Zend_Controller_Action implements Zend_Controller_Action_Interface 
{ 

例：@category、@package、@copyright、@license。それらは第1と第2のコメントブロックで2回繰り返されます。

私はコメントのベストプラクティスを探していましたが、コードを分析しながら、この質問を思いつきました。

あまりにも単純すぎると私を責めないでください。

Answer 1

Zend Frameworkを使用して、phpDocumentatorを使用してテクニカルドキュメントをレンダリングしてください。

はphpDocumentatorが@packageタグを解析することができる2つの方法があり、ファイルを読み込み、それを解析する方法あなたは気づいた行動は次のとおりです。

• ページレベルのパッケージには、
• （定義は、機能は、含まれます）クラス・レベル・パッケージ（クラス、変数、メソッド）

@licenseと@copyrightページが任意の要素に関連付けることができる（ページを含む、定義、メソッド、変数など）

偉大な文書を実現するための良いリソースはthe phpDoc official manualです。

Answer 2

私は事実を知らないが、PHPファイルの先頭にあるものとクラスの上にあるドキュメントブロックのために、別々の定義済みのテンプレートがあるためだと思われる。クラスも含まれているファイルでは、この重複が見つかります。