如上所示,可选参数要在参数表的末尾,而且老是尽可能前往成心义的函数值。
关于正文:
关于类的在线文档,应当可以被PHPDoc转换,就象JavaDoc那样。PHPDoc也是一个PEAR的使用法式,更具体的引见你可以去 http://www.phpdoc.de/ 检查。除类的在线文档,建议你应当利用非文档性质的正文来诠释你的代码,当你看到一段代码时想:哦,我想不需求在文档里去细心描写它吧。那末你最好给这段代码作一个复杂的正文,如许避免你会健忘它们是若何任务的。关于正文的模式,C的 /* */和C++的//都不错,不外,不要利用Perl或shell的#正文体例。
包括代码:
不管甚么时分,当你需求无前提包括进一个class文件,你必需利用requre_once;当你需求前提包括进一个class文件,你必需利用include_once;如许可以包管你要包括的文件只会包括一次,而且这2个语句共用统一个文件列表,所以你不必忧虑两者会搅浑,一旦require_once 包括了一个文件,include_once不会再反复包括不异的文件,反之亦然。
PHP代码标志:
任什么时候候都要利用<?php ?>界说你的php代码,而不要复杂地利用<? ?>,如许可以包管PEAR的兼容性,也利于跨平台的移植。
文件头的正文声明:
一切需求包括在PEAR中心宣布的PHP代码文件,在文件入手下手的时分,你必需到场以下的正文声明:
/* vim: set expandtab tabstop=4 shiftwidth=4: */
// +----------------------------------------------------------------------+
// | PHP version 4.0 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |
// +----------------------------------------------------------------------+
// | This source file is subject to version 2.0 of the PHP license, |
// | that is bundled with this package in the file LICENSE, and is |
// | available at through the world-wide-web at |
// | http://www.php.net/license/2_02.txt. |
// | If you did not receive a copy of the PHP license and are unable to |
// | obtain it through the world-wide-web, please send a note to |
// | license@php.net so we can mail you a copy immediately. |
// +----------------------------------------------------------------------+
// | Authors: Original Author |
// | Your Name |
// +----------------------------------------------------------------------+
//
// $Id$