1 / 11
文档名称:

PHP编码规范.doc

格式:doc   页数:11页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

PHP编码规范.doc

上传人:fy5186fy 2016/7/7 文件大小:0 KB

下载得到文件列表

PHP编码规范.doc

相关文档

文档介绍

文档介绍:PHP 编码规范 PHP 编码规范说明既然是规范,就希望大家都能够严格遵守,并依据它养成编码****惯。一般不会出现 2 个都行的情况, 比如 tab 和4 个空格都行, 结果导致代码混乱。通用原则 1 、语义化看到名字,就知道意思。 2 、通用前缀 is 表示是否、 get 表示读、 set 表示写。 is 后面优先跟形容词, 而不是名词,比如是否多语言文字,应使用 is_multilingual ,而不是 is_multilanguage 。 3 、单数与复数参考 js 的函数命名规则: getElementById 、 getElementsByTagName 、 getElementsByName 。例如: 取我的多个好友的名字,应使用 getFriendsName ,而不是 getFriendNames 或者 getFriendName 取一个用户,是 getUser 取多个用户,是 getUsers 4 、冗余后缀尽量不使用 data 、 list 、 info 后缀,除非特殊情况。比如, js 的命名就很注意,使用 getElementsByTagName 而不是 getElementsInfoByTagName 。应该使用 getFriends 或者 getFriendsUserId ,而不是 getFriendsList ;应该使用 getUser ,而不使用 getUserInfo 或者 getUserData 。不过有时候很难避免,比如有 2 个函数,分别是取用户基本信息,和取用户详细信息。取用户基本信息:昵称、头像 URI ,函数名 getUserBasic 还是 getUserBasicInfo ?函数名以形容词结尾感觉不合适,所以 getUserBasicInfo 合适。取用户详细信息: 昵称、头像 URI 、签名、生日, 函数名 getUser 没问题。 5 、含义模糊的类名、文件名、目录名 mon 、 util 、 functions 、 class 、 object 、 basic 作为文件名时要慎重,由于这些词太通用,发展下去里面东西可能越来越多, 变成垃圾箱。要给这些起一个准确的名字, 比如要做字符串处理的类,可以叫 ,放在 lib 目录里。 6 、书写规范每行代码长度应控制在 80 个字符以内,最长不超过 120 个字符。因为 linux 读入文件一般以 80 列为单位, 就是说如果一行代码超过 80 个字符,那么系统将为此付出额外操作指令。这个虽然看起来是小问题,但是对于追求完美的程序员来说也是值得注意并遵守的规范。每行结尾不允许有多余的空格。编码规范类名: 大写字母开头,驼峰命名。一般使用名词,比如配置解析类 ConfigParser ,而不是 ParseConfig 。与 Java 、 C++ 一致。例如: class UserModel 类的文件名: 与类名相同。这与 php autoload 有关。与 Java 一致。例如: class UserModel 的文件名为 非类文件名: 全小写,下划线分隔,不得使用空格。比如 。目录名: 全小写,下划线分隔,不得使用空格。比如 model 、 www 。函数名: 小写字母开头,驼峰命名,例如: function addBlog() 。与 Java 、 C++ 一致。函数表示功能,即动作,所以动词优先,例如使用 editBlog ,而不用 blogEdit 。 PHP 内置函数由于历史原因,有多种风格, do_something,something_do,dosomething, 比较新的函数用了 doSomething ,才与目前主流语言保持一致。比如: paser_str 、 json_encode 、 substr 、 fetchAll 。历史原因可能无法改变, 但我们能保证新的代码是严谨的, 不要让自己成为历史原因。类中的函数: 两个函数中间空一行。如果有时间的话,各个函数按英文字母排序, 免得太混乱。例如: class BlogModel { public function addBlog() {} public function updateBlog() {}} 文件注释: 注释紧跟<?php 下一行。注明作者。***@version 暂不需要写, 因为 svn 提供了版本管理。格式按照 PHPdoc 的要求: http://manual./HTMLframesConverter/default/phpDoc umentor/ <?php /** * blog 的各种业务:添加、更新* ***@auth