4. 帮助与共享
4.1. 重用您和其他人的艰苦工作
跨工程的重用在没有一个通用结构的情况下几乎是不可能的。对象符合他们现有的服务需求，不同的过程有着不同的服务需求环境，这使对象重用变得很困难。
开发一个通用结构需要预先花费许多的努力来设计。当努力不成功的时候，无论出于什么原因，有几种办法推荐使用：
4.2. 请教！给群组发Email求助
这个简单的方法很少被使用。因为有些程序员们觉得如果他向其他人求助，会显得自己水平低，这多傻啊!做新的有趣的工作，不要一遍又一遍的做别人已经做过的东西。
如果你需要某些事项的源代码，如果已经有某人做过的话，就向群组发email求助。结果会很惊喜哦！
在许多大的群组中，个人往往不知道其他人在干什么。你甚至可以发现某人在找一些东西做，并且自愿为你写代码，如果人们在一起工作，外面就总有一个金矿。
4.3. 告诉！当你在做事的时候，把它告诉所有人
如果你做了什么可重用的东西的话，让其他人知道。别害羞，也不要为了保护自豪感而把你的工作成果藏起来。一旦养成共享工作成果的习惯，每个人都会获得更多。
4.4. 小型代码库
对于代码重用，一个常见的问题就是人们不从他们做过的代码中做库。一个可重用的类可能正隐蔽在一个程序目录并且决不会有被分享的激动，因为程序员不会把类分拆出来加入库中。
这样的其中一个原因就是人们不喜欢做一个小库，对小库有一些不正确感觉。把这样的感觉克服掉吧，电脑才不关心你有多少个库呢。
如果你有一些代码可以重用，而且不能放入一个已经存在的库中，那么就做一个新的库吧。如果人们真的考虑重用的话，库不会在很长的一段时间里保持那么小的。
4.5. 知识库
很多公司不清楚现有什么代码可用，而且大多数程序员仍然没有通过沟通他们已经做过了什么，或者一直在询问现存什么代码可用。解决这个的方法是有一个可用的知识库。
理想的情况是，程序员可以到一个WEB页，浏览或者查询打包的知识库列表，找到他们所要的。建立一个程序员可以自动维护的知识库系统，是一个很不错的做法。如果有一个专门的管理员来负责维护这个知识库，那当然更好。
另一种方法是自动的从代码中产生知识库的做法。把通用的类、方法和标头（subsystem headers）作为手册或者是知识库的一个条目。
5. 书写注释
5.1. 讲一个故事
把你的注释当作描述系统的一个故事。并且使得你的注释能被机器解析后，以固定的格式放到手册中去。类的注释是故事的一部分，方法的名称、方法的注释、方法的实现也是故事一部分。所有的这些部分编织在一起，使得人们在以后的时间里能够准确的知道你干了什么，为什么这么做。
5.2. 归档注释
注释的要归档才有意义，否则，假如在一个地方放一条注释描述你做了什么选择和你为什么这么做，只有考古学家才能发现这是最有用的信息。（如何归档另行规范）
5.3. 注释结构
工程的每部分都有特定的注释结构。 程序中的注释，这里给出示例作为规范，注释中以 * @ 为关键字的开始，以:为注释关键字结尾。
5.3.1. 预定义关键字
关键字 含义
Purpose 表示类、属**、方法要做些什么或者什么含义。
Package Name 类名
Author 作者
Modifications 修改记录（编号规则为“No”＋日期＋“－”＋序号）
See 参考
Method Name 方法名
Parameter 参数名（包括类型）
Return 返回值（包括类型）
Attribute/Variable Name 属**/变量名
Type 属**/变量类型
5.3.2. 类的注释
/**
* @ Purpose:
* 访问数据库的类，以ODBC作为通用访问接口
* @Package Name: Database
* @Author: Forrest Gump gump@crtvu.edu.cn
* @Modifications:
* No20020523-100:
* odbc_fetch_into()参数位置第二和第三个位置调换
* John Johnson John@crtvu.edu.cn
* @See: (参照)
*/
class Database
{
……
}
5.3.3. 方法注释
/**
* @Purpose:
* 执行一次查询
* @Method Name: Query()
* @Parameter: string $queryStr SQL查询字符串
* @Return: mixed 查询返回值（结果集对象）
*/
function（$queryStr）{……}
5.3.4. 属**或变量注释
/**
* @Purpose:
* 数据库连接用户名
* @Attribute/Variable Name: mDbUserName
* @Type: string
*/
var mDbUserName;
5.3.5. if (0)来注释外部代码块
有时需要注释大段的测试代码，最简单的方法就是使用if (0)块：
function example()
{
great looking code
if (0) {
lots of code
}
more code
}
你不能使用/**/，因为注释内部不能包含注释，而大段的程序中可以包含注释。
5.3.6. 目录文档
所有的目录下都需要具有README文档，其中包括：
・ 该目录的功能及其包含内容
・ 一个对每一文件的在线说明（带有link），每一个说明通常还应该提取文件标头的一些属**名字。
・ 包括设置、使用说明
・ 指导人们如何连接相关资源：
o 源文件索引
o 在线文档
o 纸文档
o 设计文档
・ 其他对读者有帮助的东西
考虑一下，当每个原有的工程人员走了，在6个月之内来的一个新人，那个孤独受惊吓的探险者通过整个工程的源代码目录树，阅读说明文件，源文件的标头说明等等做为地图，他应该有能力穿越整个工程。
6. 其他
・ 采用面向对象的设计方法；
理由
毫无疑问这是最接近人们自然思维的方法，可能前期会觉得没有直接书写来得快，能否试着保留自己的看法？好戏在后头！
・ 类的定义采用一个文件一个类，并且类名和文件名相同；
理由
o 越来越多的人接受了这种做法
o 事实证明这种方法使得项目的逻辑结构更清晰
・ 类定义文件中，定义体之外不得出现诸如echo、print等输出语句；
理由
出现这样的语句，应该当做出现bug来看。
・ 输出网页的页面不出现SQL语句
理由
这是n层结构的编程思想所致，每层的任务不同，虽然可以越权行使，可能这样很快捷，但我们不赞成这么干。
・ 进行SQL执行的数据必须进行有效**检测
特殊符号：
对于MS SQL Server，’%_[ ] 这些符号都是在书写SQL语句中的特殊含义字符，在SQL执行前需要对这些字符进行处理。
脚本符号：
对于
PHP脚本标记，如<??><%%><?php?><script lang<script language="php"></script>，在进入数据库前需要检测处理。
理由
这是数据库编程的一个约定，很多参考书上也是这么说，这里需要强调一下。
・ 在HTML网页中尽量不要穿插PHP代码
循环代码和纯粹变量输出（类似于<?=$UserName?>）除外。
理由
o 需要说明的是我们工作的上游，页面设计者的工作，假如在页面中穿插代码，将破坏结构，这应当是我们需要避免的。
o 在这里的PHP代码只负责显示，多余的代码显然是不应该的。
・ 没有含义的数字
一个在源代码中使用了的赤裸裸的数字是不可思议的数字，因为包括作者，在三个月内，没人它的含义。例如：
if (22 == $foo) { start_thermo_nuclear_war(); }
else if (19 == $foo) { refund_lotso_money(); }
else if (16 == $foo) { infinite_loop(); }
else { cry_cause_im_lost(); }
在上例中22和19的含义是什么呢？如果一个数字改变了，或者这些数字只是简单的错误，你会怎么想？
使用不可思议的数字是该程序员是业余运动员的重要标志.
你应该用define()来给你想表示某样东西的数值一个真正的名字，而不是采用赤裸裸的数字，例如：
define("PRESIDENT_WENT_CRAZY", "22");
define("WE_GOOFED", "19");
define("THEY_DIDNT_PAY", "16");
if (PRESIDENT_WENT_CRAZY == $foo) { start_thermo_nuclear_war(); }
else if (WE_GOOFED == $foo) { refund_lotso_money(); }
else if (THEY_DIDNT_PAY == $foo) { infinite_loop(); }
else { happy_days_i_know_why_im_here(); }
现在不是变得更好了么？
7. PHP文件扩展名
常见的PHP文件的扩展名有：html, .php, .php3, .php4, .phtml, .inc, .class...
这里我们约定：
・ 所有浏览者可见页面使用.html
・ 所有类、函数库文件使用.php
理由
・ 扩展名描述的是那种数据是用户将会收到的。PHP是解释为HTML的。
8. PHP代码标记
统一使用<?php ?>，只输出变量时<?=$username?>PHP 编程风格规范
第1章 命名规范
1.1变量
1.1.1全局变量
全局变量使用$g_开头，如$g_data_list。
1.1.2 一般变量
一般的变量使用小写字母命名，单词之间使用下划线分隔。
变量名字应该使用名词或者形容词+名词的方式。如$value，$new_value。
1.1.3 临时变量
不要将在循环中频繁使用的临时变量如$i,$j等用于其它用途。
1.2 函数
函数采用小写字母命名，单词之间使用下划线分隔。
函数的命名建议使用动词+名词的方式，如get_user_img。
完成一组功能的函数放到一个文件中，存放函数的文件采用function_name.func.php命名。
1.3 类
类使用英文的大小写来分隔单词，包括首个单词，所有单词的首字母大写，如PageManager；
在类中，方法放到属性定义前边、公用方法放到专用方法前边；
一般情况下，一个类对应到一个文件；
当一些类关系紧密时，可以存放在一个文件中；
存放类的文件采用ClassName.class.php方式命名。
1.4 方法
方法使用英文的大小写来分隔单词，除首个单词外，其他单词的首字母大写，如getCurrentPage()；
不要采用不常用的缩写，如where2go()；
使用常用的缩写时，只大写首字母，如getHtml()。
第2章 版式规则
2.1 语义分隔
各个函数、方法之间应该采用空行间隔；
同一个函数中联系紧密的语句之间可以不换行，其他情况需要换行。
2.2 空格规则
2.2.1 逻辑运算符前后必须加空格
正确 $a == $b;
错误 $a==$b;
$a ==$b;
备注 -
正确 $a++; $a--;
错误 $a ++; $a --;
备注 加一减一运算符不能加空格。
2.2.2 多个参数分隔时必须加空格
正确 $g_pro , $g_user , g_show;
get_db_info($host, $user, $passwd);
错误 $g_pro,$g_user,$g_show;
get_db_info($host,$user,$passwd);
备注 -
2.2.3 语法关键字后必须加空格
例如：If, for , while, switch …..
正确 for ($i = 0; $i < 10; $i++)
错误 for($i = 0; $i < 10; $i++ )
备注 -
2.3 字符串和变量连接规则
字符串与变量连接使用'.'号时，必须在'.'前后加空格，使用"号时，必须在变量前后加"{}"。
正确 $my_name = 'file_' . $var1;
$my_name = "file_{$var1}";
错误 $my_name = "file_'.$var1;
$my_name = "file_$var1";
备注 -
2.4 圆括号规则
函数名后括号不需要加空格、语法关键字后的括号必须加空格。
正确 for ($i = 0; $i < 10; $i++)
strlen($my_name);
错误 for($i = 0; $i < 10; $i++ )
strlen ($my_name);
备注 -
2.5 花括号规则
花括号必须为上下对应。
正确
if ($a)
{
$b = $a;
}
错误 if ($a){
$b = $a;
}
备注 -
2.6 数组定义规则
数组定义和使用时中key值前后必须加单引号。
PHP 代码:
正确
$user_info = array(
'name' => '',
'gender' => ''
);
echo $user_info['name'];
错误
$user_info = array(
name => '',
gender => ''
); echo $user_info[name];
备注 -
2.7 SQL规则
在PHP中嵌入的SQL语句关键字全部采用大写；
表名和字段名要用反引号(`)引起来以防止因为字段名中包含空格而出现错误；
数据值两边用单引号''包括，并且应确保数据值中的单引号已经转义以防止SQL注入。
正确 $sql = "SELECT `user`.`name` FROM `user` WHERE `id` = '$id' LIMIT 1";
错误 $sql = "select name.user from name where id = $id ";
备注 -
第3章 注释规则
3.1 一般规则
不写不必要的注释；只有当代码不能很好地说明逻辑时，才用注释补充；
把注释看成程序的一部分，在编写/维护代码时同时编写/维护注释；
注释完全采用PHPDocumentor的规范，以方便用其生成API级文档。
3.2 详细规则
请参见PHPDocumentor手册。下边给出各个部分的注释示范。
3.2.1 版权信息
注释名称 版权信息
注释示范 //
// +----------------------------------------------------+
// | phpDocumentor |
// +----------------------------------------------------+
// | Copyright (c) 2000-2003 Joshua Eichorn |
// | Email jeichorn@phpdoc.org |
// | Web http://www.phpdoc.org |
// +----------------------------------------------------+
// | This source file is subject to PHP License |
// +----------------------------------------------------+
//
备注 使用//来标示版权信息，以免和PHPDocumentor的page-level DocBlock发生冲突
3.2.2文件头注释示例
注释名称 文件头注释
注释示范
PHP 代码:
/**
* All abstract representations of inline tags are in this file
* @package phpDocumentor
* @subpackage InlineTags
* @since separate file since version 1.2
* @version $Id $
*/
备注
1 文件头注释需要指明所属的包和子包
2 在@version中加上$ID，以方便使用CVS管理文件
3.2.3 类注释示例
注释名称 类注释
注释示范
PHP 代码:
/**
* Use this element to represent an {@}inline tag} like {@}link}
* @see parserStringWithInlineTags
* @package phpDocumentor
* @subpackage InlineTags
* @author Greg Beaver <cellog@users.sourceforge.net>
* @since 1.0rc1
* @version $Revision: 1.21.2.6 $
* @tutorial inlinetags.pkg
*/
备注 -
3.2.4 类属性注释示例
注释名称 类属性注释
注释示范
PHP 代码:
/**
* Element type
*
* Type is used by many functions to skip the hassle of
*
* <code>
* if get_class($blah) == 'parserBlah'
* </code>
* always "inlinetag"
* @var string
*/
var $type = 'inlinetag';
备注 -
3.2.5 函数/类方法注释示例
注释名称 函数/类方法注释
注释示范
PHP 代码:
/**
* @return string always ''
* calculate the short description of a DocBlock
* @see parserStringWithInlineTags::getString()
* @see parserStringWithInlineTags::trimmedStrlen()
*/
function getString()
{
return '';
}
