麻辣堂|资源主站|开发论坛|在线手册
首页 Apache Linux Java MySQL 注册帮助 
PHP项目开发组是PHP开发资源网于2007组年建成立的项目开发团队,目前核心开发成员有27人, 项目协作成员8名.下设7个开发组,主要承接大/中型网站项目开发任务。

    由于开发任务较多,人员比较紧张,现面向社会招聘全职或者兼职开发人员,不管你是在校大学生,还是全职开发人员,以及SOHO都可以联系本站,我们可以长期合作,并为您带来丰厚的报酬。
  您现在的位置:PHP开发资源网 > 麻辣堂 > 详细资料
待解决
我在一个软件里看到的,不知道大家怎么看
悬赏分:20 - 2007年06月04日

基本规范
◇ 优先级:代码设计优先级别原则依次是正确性、执行效率高(优化)、可读性;
◇ 结构化设计:将要解决的问题定义成若干对象,在对象内部,采用模块化的代码设计;无论事件脚本还是函数都要遵守单入单出的原则;
◇ 程序风格:程序结构清晰,简单易懂;单个函数或过程的程序行数(包括注释)不得超过500行、宽度不超过屏幕显示的宽度范围;避免太多的分支结构及太过于技巧性的程序;一般不得采用递归模式,当不得不采用时应避免死循环;GOTO语句在一个代码段内(比如一个函数、过程、事件、算法等),GOTO语句最多只能使用一个;对于多路分支,最好用Case语句;循环、分支要简单:层次不得超过五层;禁止出现两条等价的支路;避免不必要的分支;判断条件与执行代码不得在同一行上;
◇ 可读性:一定要注释清晰,必须注释与代码同步;利用缩进来显示程序的逻辑结构:根据不同开发工具利用空格(至少两个)或Tab字符来组织代码缩进结构;
◇ 代码重用:提高函数或过程的共享,同组内将功能相同代码作为公用函数或过程,不得各行其事,尽量简化编码,减少不必要的重复代码;
◇ 变量使用:变量使用遵循先声明后使用的原则,变量声明应该集中在代码头部;尽量使用局部变量,不得随意定义全局变量;
◇ 命名规范:所有对象的命名必须能准确清晰的代表当前对象的实际意义,必须使用英文单词,力求见名知义,不得使用单独的保留字或关键字命名;如果名称太长,可以使用部分重点单词相连,能接近本意即可。
◇ 防止内存泄漏:对于服务器端运行的程序,任何创建的非可视或动态对象,在使用结束时必须及时从内存删除,确保资源及时释放。
◇ 写SQL语句时,关键字用大写,字段名和表名用小写。如:
SELECT id,name FROM test WHERE id=1
不要出现SELECT * ,用什么字段取什么字段,即使全部字段,也不能用*代替,要每个字段都写出来。

注释规范
代码一定要注释,用简练准确易于理解的语句说明当前的代码,使其它组员和自己随时都能根据注释用最短的时间理解代码;注释可以与语句在同一行,也可以在语句的上一行;保持注释与代码完全一致,原则上使用中文注释。
每类注释中都包含了日期,根据日期可以随时跟踪某个时间段内所编写的代码。注释中的日期可以有四种格式:YYYY.MM.DD、YYYY/MM/DD、YYYY-MM-DD和YYYY年MM月DD日。
注释规范包括文件头注释和代码修改处的注释两部分。
每行注释符号不得超过72个字符;
注释格式:
源程序代码文件
PHP中的每个php代码文件等都必须有文件头说明注释。注释格式如下:
/***********************************************************************
模块编号:
模块名称:
功能描述:
版本:
创建日期:
作者:
==========================================================
-----------------------修改记录----------------------------------
修改人: 修改时间:
修改原因:
-----------------------------------------------------------------
==========================================================
备注:
***********************************************************************/
过程、函数注释
在每一个过程或函数的前面,注释如下:
/***********************************************************************
函数或过程名称:
输入参数:
输出参数:
功能描述:
流程处理:
全局变量:
调用方法:lr_FinedFee = FinedFee(real 本金,Real 本年度滞纳金比率,Real 跨年度滞纳金比率,Date 缴费截至日期,Date 实际缴费日期)
调用样例:
作者:
创建日期:
复杂的函数需要加上变量用途说明
==========================================================
-----------------------修改记录-----------------------------------
修改人: 修改时间:
修改原因:
-----------------------------------------------------------------
==========================================================
备注:
***********************************************************************/
事件注释
在每一个事件的前面,注释如下:
/***********************************************************************
事件名称:
事件功能:
作者:
创建日期:
==========================================================
----------------------------修改记录------------------------------------
修改人: 修改时间:
修改原因:
------------------------------------------------------------------------
==========================================================
备注:
***********************************************************************/
代码修改注释
适用于版本封存以后的修改。经过批准,对源文件进行修改时,修改者必须保留修改前的内容,不能自行删除或直接修改;并标识出修改、新增或删除的内容。修改者都必须在该项目中填写修改信息,首先必须在当前文件的文件头修改记录中加入修改信息,并且在代码修改处加上修改注释:
代码修改处的注释根据不同的修改动作分以下三个方面:
◇ 新增代码行
在程序中新增若干代码行时,应该在新增代码行的前后加上注释行说明。
/*******************************************************************
-----------------------修改记录-----------------------------------
修改人: 修改时间:
修改说明(如何修改):
------------------------------------------------------------------
********************************************************************/
// 新增代码行
新增的代码行
// 修改结束
◇ 删除代码行
在程序中删除若干代码行时,应该在被删除的代码行前后用注释行说明。
/*******************************************************************
-----------------------修改记录-----------------------------------
修改人: 修改时间:
修改说明(如何修改):
要删除的代码行
修改结束
------------------------------------------------------------------
********************************************************************/
◇ 修改代码行
在程序中修改代码行时,首先删除代码行,然后新增代码行。
/*******************************************************************
-----------------------修改记录-----------------------------------
修改人: 修改时间:
修改说明(如何修改):
修改前的代码行:
修改结束
------------------------------------------------------------------
********************************************************************/
//修改后的代码行
修改后的代码行。。。。。
//修改结束
程序中的注释
在不同的代码段中第一次引用变量时,必须注释其含义;处理过程说明;算法说明;
自定义的变量常量、类型、结构等都必须有其用途说明。

制约与约束关系
必须合理设计系统的控件、数据之间的关联、制约关系。确保在逻辑上有制约关系的控件和数据项之间合理、协调。举例如下:
◇ 在没有检索到数据的情况下相应打印、删除等操作的命令按钮或菜单项应处于无效状态;
◇ 当实际数据具体改动之前和存盘成功后,存盘命令按钮和菜单必须处于无效状态;
◇ 当实际数据具体改动之后立即使存盘命令按钮处于有效状态;初始状态下,插入命令按钮和插入菜单项应处于有效状态,当单击该命令按钮和菜单项后状态失效、数据存盘成功后生效。

提示框的使用
各种提示信息或错误信息,应该使用项目组内部统一的提示框界面。并不是所有数据操作都需要提示,提示框使用与否列举如下:
◇ 对所有的用户输入,必须进行合法性检查,严格控制不同类型及长度的输入。例如用户在数字型的输入框只能输入数字或小数点,并且正确,使用函数或过程自动控制当前输入框不接受其它字符,不要再有错误提示(如请输入数字等提示);
◇ 进行保存数据的操作时,如果出现异常即不能成功保存数据,则需要提示无法保存;否则直接保存,不要再提示类似是否真的保存之类的提示框;
◇ 点击删除按钮删除数据前必须首先提示是否真的删除之类的提示框,在用户确认删除后,才能删除数据,否则不能删除数据。
◇ 关闭窗体(包括点击窗体上的关闭按钮和窗体右上角自带的Windows关闭框)前,应该检查是否有未保存的动作(删除、修改、新增等),如果有,需要提示是否保存;否则直接关闭;

客户端JavaScript对象命名规范
各种页面对象如text输入框、按钮、下拉选择框在命名时必须使用以下对应前缀+功能描述性单词(每个单词的第一个字母大写,其余的全部小写): 如txtName(名称的输入框);页面对象前缀如表所示:
对象 前缀
Text输入框 txt
button按钮 btn
select下拉选择框 sel
option项 opt
form表单 frm
frame框架 fra
hidden表单项 hdn
div标记 div
span标记 span
对话框对象 dlg
窗口对象 win

提问者:coldwind   06-04 08:08
答复
路过。。。顺便帮顶:)
回答者:玉米づ冰冻可乐 - 瓦岗村民 8-22 09:10
我也来回答:
不管你有没有帮助我们,瓦岗寨8万村民将感谢你。。。。。

为防止灌水,您需要计算一道数学题: 答案:
57 + 70 = ? 请将计算结果填在上面

 
[]
©2007 PhpRes.COM