人力検索はてな
モバイル版を表示しています。PC版はこちら
i-mobile

phpの自作関数について

自分で作っておきながら、
何を渡せば、何が、どう帰ってくるのか...ということを
数日で忘れてしまうことがあります。

わからなくならないためにコメントなどを書くと思うのですが
皆さんはどのようなことを、どのように書きますか。

具体的に書いて教えてください。

よろしくお願いします。

●質問者: worldtravel
●カテゴリ:コンピュータ ウェブ制作
✍キーワード:PHP コメント 自作 関数
○ 状態 :終了
└ 回答数 : 4/4件

▽最新の回答へ

1 ● tasklight
●23ポイント

phpDocumentorでドキュメント作成できるように、以下のようなコメントを入れています。

/**
* hogeの説明
* 
* @param string $arg 第一引数
* @param integer $arg2 第二引数
* @return array 戻り値の説明
*/
◎質問者からの返答

ありがとうございました。


2 ● きゃづみぃ
●23ポイント

コーディング規約

普通は コーディング規約で決めている場合も多いです。

http://www.coding-standard.com/MC_C/index.html

http://www.coding-standard.com/MC_C/16_.html

上記のは Cなどの場合ですが、このような形で

変数のコメントを 記述したらいいでしょう。

◎質問者からの返答

なるほど!

ありがとうございました。


3 ● hamsterxxx
●22ポイント

http://phpnokowaza.seesaa.net/article/10698033.html

http://php-web.net/source/comment.html

プログラム中のコメントの書き方は人によって癖なども有りますので、ご自分が分かり易いとか、書き易いとか、かっこ良いとかと思った書き方を考えるとプログラミングが楽しくなります。

個人的に書き方を披露するのは気恥ずかしいので、同じ様な書き方を教えているサイトの内容を挙げる事にします。

http://phpspot.net/php/pgphpDocumentor%97p%83R%83%81%83%93%83g%8...

関数/メソッドの場合

例えば、

function hoge($arg,$arg2){}

という関数があったとして、

第一引数の型が 文字列型、$arg2 の型が 整数型だった場合で、戻り値が配列型であった場合、コメントは、

/**

* hogeの説明

*

* @param string $arg 第一引数

* @param integer $arg2 第二引数

* @return array 戻り値の説明

*/

のようになります。

型として、string や integer のほかに、object(オブジェクト), array, mixed(いろんな型が返る場合), resource(リソース型) といったものが使えます。

オブジェクトのメソッドの場合は、アクセス修飾子として、

@access public

@access private

@access protected

をのいずれか指定しておいた方がよいでしょう。

変数/define定数

/**

* 説明

* @see 関連関数1,関連関数2

*/

のように書きます。

クラスの場合

/**

* クラスの説明

*

* @package パッケージ名

* @author 著作者 <著作者メール>

* @since PHP 4.0

* @version $Id: DB.php,v 1.58 2004/03/13 16:17:19 danielc Exp $

*/

こういう感じに書きましょう。

◎質問者からの返答

ありがとうございました。


4 ● ymlab
●22ポイント

私は、ドキュメント生成ツールを使っています。

http://www.schwarzefarbe.net/blognplus/index.php?e=216&PHPSESSID...

javaなら最初からjavadocがあって、便利なのですけどね。

◎質問者からの返答

ありがとうございました。

関連質問


●質問をもっと探す●



0.人力検索はてなトップ
8.このページを友達に紹介
9.このページの先頭へ
対応機種一覧
お問い合わせ
ヘルプ/お知らせ
ログイン
無料ユーザー登録
はてなトップ