编码规范
        
命名规范

1.1、主要的目录 control 里面是控制类 ,前台命名为something.php,则后台对应的是admin_+前台名称,名称应选有意义的英文单词,例如 前台词条 doc.php,后台词条管理对应的 admin_doc.php

1.2、model目录下个文件是功能模块,命名以 control名称+".class.php" ,例如control中doc.php对应是 doc.class.php
1.3、view是视图类,前台某功能命名为主,如login.htm,space.htm等,若不好命名,以"动词"+"control名称",例如浏览词条可命名为viewdoc.htm,后台命名统一加上admin_前缀,如admin_login.htm 、admin_index.htm等
1.4、lib目录下为基础类,命名用个类的名称为主,如hddb.class.php 、xml.class.php、json.class.php 等
1.5、文件名全部小写,类名,类的方法名全部小写。
1.6、变量名称应使用有意义的小些英文单词或组合命名,中间无任何分隔符,如$doc,$user,$category,$onlineip等等,勿使用拼音或者无意义的$temp,$data等来给变量命名
1.7、常量全部用大写字母,"HDwiki_有意义的英文单词或组合",如define('HDwiki_VERSION', '1.0.0');
1.8、一些列表数据采用“名词+list”,如词条列表数据的变量名使用$doclist,用户列表数据的变量使用$userlist等
1.9、函数或者类的方法命名用小写的英文单词或组合命名,如是组合请用下划线_分割,如 function parse(),function add_doc(),function get_user()等

开发规范
2.1、所有的url都是从 index.php? 开始的,第一个参数是调用的控制器,第二个参数是方法名字,第三个以后的都是方法的参数,例如index.php?doc-view-1 表示 调用/control/doc.php的doview方法,1是该方法的参数
2.2、删除无用的注释,包括无用的函数和方法。
2.3、if语句格式 :需要用大括号,即使只有一句话,例如if(a) echo 'a'; => if(a) { echo 'a'; }
2.4、缩进格式,采用TAB方式缩进
2.5、保证各方法需要有返回值时做有返回值处理,不需要时勿返回值,保证程序异常处理
2.6、杜绝在for循环中调用本可以一次调用的函数或方法如:
for($i=0,$con=count($order);$i<$con;$i++){
$this->db->query("update ".DB_TABLEPRE."friendlink set displayorder=".$i." where id=".$order[$i]);
}
2.7、不需要赋值的地方请勿赋值 如
function addlink($link){
$query = $this->db->query("INSERT INTO ".DB_TABLEPRE."friendlink (name,url,description) VALUES ('$link[name]','$link[url]','$link[description]')");
}
直接写成如下方式即可:
function addlink($link){
$this->db->query("INSERT INTO ".DB_TABLEPRE."friendlink (name,url,description) VALUES ('$link[name]','$link[url]','$link[description]')");
}
2.8、若中间数据可直接返回,请勿再次赋值如:
function get_pms($id){
$pms=$this->db->fetch_first("SELECT * table");
return $pms;
}直接改为:
function get_pms($id){
return $this->db->fetch_first("SELECT a. * ,b.username FROM ".DB_TABLEPRE."pms a,".DB_TABLEPRE."user b where a.toid=b.uid and a.id='".$id."'");
}
2.9、sql语句中:sql关键字大写、表名小写。sql语句坚决不用子查询。不用存储过程、不用外键、不用触发器等。记录数,采用 select count(*) from 表名 的方式
2.10、函数内的局部变量在函数的第一句开始处定义。
2.11、函数和函数之间空一行。
2.12、大括号格式
function get_lastdoc($docid,$doctime){;
}
2.13、写法 if($type=='') 改为 if(''==$type)

hdwiki 编码规范的更多相关文章

  1. Android的编码规范

    一.Android编码规范 1.学会使用string.xml文件 在我看来,当一个文本信息出现的次数大于一次的时候就必须要使用string.xml 比如一个保存按钮 , 不规范写法: <Butt ...

  2. PHP 高级编程(1/5) - 编码规范及文档编写

    PHP 高级程序设计学习笔记20140612 软件开发中的一个重要环节就是文档编写.他可以帮助未来的程序维护人员和使用者理解你在开发时的思路.也便于日后重新查看代码时不至于无从下手.文档还有一个重要的 ...

  3. 【原】JAVA SE编码规范

    /* * 编码规范: * 1.所有的命名遵循"见名知意"的原则 * 2.所有的命名不允许使用汉字或拼音 * 3.Java的工程命名建议使用小写,比如:oa.crm.cms... * ...

  4. 浅谈Android编码规范及命名规范

    前言: 目前工作负责两个医疗APP项目的开发,同时使用LeanCloud进行云端配合开发,完全单挑. 现大框架已经完成,正在进行细节模块上的开发 抽空总结一下Android项目的开发规范:1.编码规范 ...

  5. PHP编码规范PSR-2

    .note-content { font-family: "Helvetica Neue", Arial, "Hiragino Sans GB", STHeit ...

  6. Objective-C开发编码规范【转载】

    概要 Objective-C是一门面向对象的动态编程语言,主要用于编写iOS和Mac应用程序.关于Objective-C的编码规范,苹果和谷歌都已经有很好的总结: Apple Coding Guide ...

  7. 前端编码规范之CSS

    "字是门面书是屋",我们不会去手写代码,但是敲出来的代码要好看.有条理,这还必须得有一点约束~ 团队开发中,每个人的编码风格都不尽相同,有时候可能存在很大的差异,为了便于压缩组件对 ...

  8. 前端编码规范之JavaScript

    上次浅谈了下关于CSS的编码规范,大部分童鞋持赞同意见,仍存在一些童鞋不太理解这些规范的意义. 如果是个人或者小作坊开发,其实这些所谓的编码规范也没啥意思,因为大家写好的代码直接就给扔到网上去了,很少 ...

  9. Java Script 编码规范【转】

    Java Script 编码规范 以下文档大多来自: Google JavaScript 编码规范指南 Idiomatic 风格 参考规范 ECMAScript 5.1 注解版 EcmaScript ...

随机推荐

  1. python 环境问题

    1. 查看python安装的模块及版本 $pip freeze Babel== Flask== Flask-HTTPAuth== Flask-RESTful== Flask-SQLAlchemy==2 ...

  2. 学习 Log4net

    遇到问题: 开发机器:WINDOWS 8, 英文版, 64位 在实际使用中发现,写在文件中的中文全部变成乱码(变成问号). 解决方法: <appender name="FileAppe ...

  3. App上架审核指南翻译

    App Store Review Guidelines APP审核指南:https://developer.apple.com/app-store/review/guidelines/ 本文是自主翻译 ...

  4. ipmi使用

    1.安装ipmitool Linux: yum -y install OpenIPMI-tools 备注:Linux机器也可以安装ipmi  yum -y install OpenIPMI OpenI ...

  5. Mybatis的批量CRUD

    CRUD与批量CRUD 分页前后缀(方言 Mysql与Oracle情况下不一样) 批量插入数据  http://chenzhou123520.iteye.com/blog/1583407/ 亟待完善 ...

  6. Three.js基础探寻九——网格

    在学习了几何形状和材质之后,我们就能使用他们来创建物体了.最常用的一种物体就是网格(Mesh),网格是由顶点.边.面等组成的物体:其他物体包括线段(Line).骨骼(Bone).粒子系统(Partic ...

  7. Java 分布式应用

  8. Lintcode: Product of Array Exclude Itself

    Given an integers array A. Define B[i] = A[0] * ... * A[i-1] * A[i+1] * ... * A[n-1], calculate B wi ...

  9. 基于Qt Phonon模块实现音乐播放器

    这次使用Qt实现的是一个本地音乐播放器,可以播放下载在计算机本地的音乐,提供了添加歌曲,歌曲列表,清空列表的功能.默认歌曲列表循环播放.音乐播放的实现主要依赖的是Qt 的多媒体框架phonon.该音乐 ...

  10. Java相对路径读取文件

    不管你是新手还是老鸟,在程序中读取资源文件总会遇到一些找不到文件的问题,这与Java底层的实现有关,不能算bug,只要方法得当,问题还是可以解决的. 项目的文件夹结构: repathtest ├─sr ...