2

私は非常に広範なWebアプリケーションを構築し、CodeIgniter（CI）のスタイルガイドを調べてコメントの作成方法を確認していました。クラスとメソッドには次のようなものがあります。

/** 
* Super Class 
* 
* @package Package Name 
* @subpackage Subpackage 
* @category Category 
* @author Author Name 
* @link http://example.com 
*/ 

class Super_class {}

/** 
* Encodes string for use in XML 
* 
* @access public 
* @param string 
* @return string 
*/ 

function xml_encode($str){}

これは問題ありませんが、これらのオプションに何を入力すればよいかわかりません。私は実際には@packageを持っていません、ただいくつかのモデルとコントローラーを持っています。Javaではセキュリティのためにパッケージを使用するかもしれませんが、CIでは使用しません。それはMVCだけです。たとえば、project_mode、projects（controller）、add_project_view.phpなどは常にあります。

また、@ categoryの形式は何ですか？phpDocumentorのドキュメントには、「@categoryタグはパッケージのグループをまとめて整理するために使用されます」と書かれています。繰り返しますが、パッケージはありません！

次に、メソッドのパラメーターはどうですか？2つの文字列と配列、または整数と配列がある場合がありますが、@ paramの形式は何ですか？

ありがとう、

4

2 に答える 2

3

パッケージ、サブパッケージ、およびカテゴリは、コードをより論理的に構造化するためのものです。所有しているすべてのプロジェクト/コード ファイルに存在する必要はありません。

一方、メソッド内のパラメーターは、コード内でこれらのメソッドを呼び出すときに渡す必要があるため、ドキュメントを読むときにそれらが何であるかを知る必要があるため、定義すると非常に便利です。

サンプルは次のようになります。

/**
 * Sample function
 * @param string $param1 name of person
 * @param integer $param2 age of person 
 * @return string 
 */
function person($name, $age)
{
    return "$name is $age years old";
}
于 2012-09-26T17:11:59.567 に答える
0

@packageは、手続き型ページまたはクラスを文書化するためにのみ使用できます。

パッケージは、関連する要素を論理的にグループ化するために使用されます。関連する関数とデータをグループ化するクラスを作成すると、phpDocumentorはファイルのコンテンツ（関数、定義、およびインクルード）を「手続き型ページ」として表します。パッケージは、ディレクトリが関連ファイルをグループ化するのと同じ方法で、クラスと手続き型ページをグループ化するために使用されます。

phpDocumentorガイドの質問への回答などをここで見つけることができます

于 2012-09-26T18:01:57.630 に答える