phpの自作関数について


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

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

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

よろしくお願いします。

回答の条件
  • 1人1回まで
  • 13歳以上
  • 登録:2010/07/30 20:11:15
  • 終了:2010/08/06 20:15:03

回答(4件)

id:tasklight No.1

tasklight回答回数323ベストアンサー獲得回数402010/07/30 20:19:12

ポイント23pt

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

/**
* hogeの説明
* 
* @param string $arg 第一引数
* @param integer $arg2 第二引数
* @return array 戻り値の説明
*/
id:worldtravel

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

2010/07/30 22:20:17
id:taknt No.2

きゃづみぃ回答回数13537ベストアンサー獲得回数11982010/07/30 20:38:35

ポイント23pt

コーディング規約

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

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

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

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

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

id:worldtravel

なるほど!

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

2010/07/30 22:20:47
id:hamsterxxx No.3

hamsterxxx回答回数50ベストアンサー獲得回数82010/07/30 20:50:04

ポイント22pt

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 $

*/

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

id:worldtravel

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

2010/07/30 22:22:09
id:ymlab No.4

ymlab回答回数506ベストアンサー獲得回数332010/07/30 21:02:26

ポイント22pt

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

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

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

id:worldtravel

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

2010/07/30 22:45:58

コメントはまだありません

この質問への反応(ブックマークコメント)

「あの人に答えてほしい」「この質問はあの人が答えられそう」というときに、回答リクエストを送ってみてましょう。

これ以上回答リクエストを送信することはできません。制限について

絞り込み :
はてなココの「ともだち」を表示します。
回答リクエストを送信したユーザーはいません