PHPコーディングルール - az @Wiki

クラス

• プライベートなメソッド、フィールドは頭に「_」をつける。

メソッドの例）
function _setSubject($str) { ... }
フィールドの例）
var $_subject;

• コンストラクタで引数あり／なしのどちらでも使えるようにする → Do You PHP?:PHP4のクラスとJavaのクラス - コンストラクタ

function send($to = null, $from = null, $subject = null, $body = null)
{ ... }

コメント

• クラスの説明

/**
 * メール送信クラス
 *
 * PEAR::Mail を使ってメール送信するクラスです。
 * 添付ファイル付きメールを送信することができます。
 *
 * 使用例）メールを送信する
 *  $mailer = new Mailer();
 *  $mailer->setTo('[email protected]');
 *  $mailer->setFrom('[email protected]');
 *  $mailer->setSubject('メールのSubject');
 *  $mailer->setBody('メールの本文');
 *  $mailer->send();
 * 使用例）添付ファイル付きメールを送信する
 *  $mailer = new Mailer();
 *  $mailer = $mailer->addAttach('添付ファイル', $data)
 *  $mailer->send('[email protected]', '[email protected]', 'メールのSubject', 'メールの本文');
 *
 * @package com.ecs.common
 * @access  public
 * @author  
 * @create  2006/04/15
 * @version $Id: Mailer.class.php,v 1.3 2006/04/15 08:50:13  Exp $
 * @see <a href="http://pear.php.net/package/mail/">PEAR :: Package :: Mail</a>
 * @see <a href="http://pear.php.net/package/mail_mime/">PEAR :: Package :: Mail_Mime</a>
 **/

• メソッドの説明

/**
 * メールを送信する
 *
 * @access public
 * @param String $to 送信先メールアドレス
 * @param String $from 送信元メールアドレス
 * @param String $subject メールの Subject
 * @param String $body メールの本文
 * @return boolean true:メール送信成功／PEAR_Error:送信失敗
 */

• フィールドの説明

/**
 * @access private
 * @var String 送信先メールアドレス
 */