http://wiki.blueidea.com/api.php?action=feedcontributions&feedformat=atom&user=SnakeZero
Blueidea - 用户贡献 [zh-cn]
2026-04-29T13:55:51Z
用户贡献
MediaWiki 1.24.1
http://wiki.blueidea.com/index.php?title=Protoss&diff=8461
Protoss
2011-05-10T10:38:45Z
<p>SnakeZero：</p>
<hr />
<div>Protoss是一款轻量级的PHP框架，目前由Snake.Zero进行日常维护。<br />
{{notice|content=Protoss读作：['prɔtɔs]。Protos在希腊语中是“第一”的意思,而“proto-”也是英文中表示"第一 主要"之义的前缀。}}<br />
<br />
== 框架简介 ==<br />
=== [[Protoss/简介|框架介绍]] ===<br />
Protoss是一款轻量的PHP框架，前身Snake Framework，历经5年积累，纯构思时间超过2年。Protoss的编写目的，是为了解决开发中的代码不规范、流程不规范、文档不规范这些问题，因为他和一些第三方助手类或快速开发框架相比，更多的'''不是'''提供了什么，反而更多是'''什么不能做，不能怎么做'''。<br />
<br />
Protoss实现的一个真正框架该有的“框架”效果。和很多以快速开发的框架一样，Protoss提供了一些助手类，这些类大大减小了开发中重复劳动的部分。然而更重要的是，它是一款以约束开发行为为目的的框架项目。它在文件、类、函数、数据表的设计上，做了相对严格的限制，使用户项目整体简洁、清晰而且方便阅读。<br />
对于员工流动大的公司，减少了新员工的学习和交流成本。<br />
<br />
另：在设计之初，Protoss的目的是成为一个真正意义上的框架，因此不光包括代码方面，同时还包括了日常文档，工作流程的规范化。但是目前而言，在一些小公司中，这些相对复杂的规范化流程的推进还是有些困难。<br />
<br />
{{notice|content=完整版概述：[[Protoss/简介|Protoss is not a underwear!]]<br/>推荐阅读：[[Protoss/为什么Protoss会更少的干涉业务逻辑|为什么Protoss会更少的干涉业务逻辑]]}}<br />
<br />
=== 框架特性 ===<br />
*摈弃PHP的MySQL扩展，转而使用更高效且面向对象的MySQLi<br />
*Model层被重视，不再是简单的ORM映射，而是真正意义上的数据模型层<br />
*相对严格的命名规范，代码更具可读性<br />
*更安全的访问权限控制<br />
*更强的代码生成工具<br />
<br />
== 快速入门指南 ==<br />
本快歌入门指南假定读者对PHP,MySQL有一定基础。知道MVC或有其他框架开发经验为佳，但是在后面也会有一定介绍。<br />
=== 轻松编程从这里开始 ===<br />
==== [[Protoss/MVC简介|MVC简介]] ====<br />
==== [[Protoss/目录结构|基于Protoss的项目特征和目录结构]] ====<br />
==== [[Protoss/运行|轻松访问到控制器]] ====<br />
<br />
=== Hello world，我的第一个应用软件 ===<br />
==== [[Protoss/控制器|编写控制器]] ====<br />
==== [[Protoss/控制器/动作|控制器中的Action]] ====<br />
==== [[Protoss/控制器/内部方法|我有许多小秘密--private和protected]] ====<br />
<br />
=== 模板引擎 ===<br />
==== [[Protoss/模板/载入模板|很给力！自动引入模板]] ====<br />
==== [[Protoss/模板|视图也可以继承]] ====<br />
==== [[Protoss/模板|看，这些元素其实是可以拆分和复用的]] ====<br />
<br />
=== [[Protoss/模型|了解数据模型]] ===<br />
==== [[Protoss/模型/mysqli|建立MySQLi数据模型]] ====<br />
==== [[Protoss/模型/rest|Rest风格的数据模型]] ====<br />
<br />
== 项目开发权威指南 ==<br />
<br />
=== [[Protoss权威指南/名词解释|名词解释]] ===<br />
<br />
== 附录 ==<br />
=== 附录 A. 代码编写与开发流程规范 ===<br />
==== [[Protoss/规范/概述|概述]] ====<br />
Subversion是一个自由/开源版本控制系统，它管理文件和目录可以超越时间。[[Protoss/规范/概述|更多(利用版本控制进行协助开发)]]<br />
<br />
==== [[Protoss/规范/代码规范|Protoss代码编写规范]] ====<br />
【[[Protoss/规范/代码规范|点此阅读Protoss代码编写规范，推荐]]】<br />
<br />
==== 工作模型 ====<br />
checkout（检出）项目<br />
更新文件或目录 update<br />
修改文件或目录 commit(提交)变更<br />
增加文件或目录 add(增加) <br />
文件或目录 commit(提交)<br />
删除文件或目录 commit(提交)上一级目录<br />
<br />
==== [[Protoss/规范/操作指南|操作指南]] ====<br />
当你在为项目工作时，首先请更新你的工作拷贝来获取那些你上次更新以来其他开发人员对项目做的新改动。[[Protoss/规范/操作指南|更多]]<br />
<br />
==== 开发与测试部署流程 ====<br />
开发人员使用trunk目录进行当前版本开发.在模拟环境中进行单元测试.[[Protoss/规范/测试和部署|更多]]<br />
==== [[Protoss/规范/核心提示|核心提示]] ====<br />
*负责而谨慎地提交自己的代码<br />
*保持原子性的提交<br />
*不要提交自动生成的文件<br />
*不要提交不能通过编译的代码<br />
*不要提交自己不明白的代码<br />
*提前宣布自己的工作计划<br />
*对提交的信息采用明晰的标注<br />
<br />
=== 附录 B. 版权信息 ===<br />
以下版权信息适用于Protoss项目，包括但不限于代码部分。（注：代码仅指Protoss框架代码，不包含开发人员基于此框架的应用程序，各应用程序开发者享有该程序代码的一切权利）<br />
<br />
Copyright &copy; 2009-2010 Snake.Zero<br />
<br />
=== 附录 C. 更新记录 ===<br />
* 2009年6月&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Protoss 0.1beta Protoss诞生<br/><br />
* 2010年6月&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Protoss 0.5beta 经过一年的开发和测试，第一个稳定版本<br/><br />
* 2010年7月24日&nbsp; Protoss 0.5.1 Mysqli模型驱动新特性<br/></div>
SnakeZero
http://wiki.blueidea.com/index.php?title=PHP%E9%9B%B6%E5%85%A5%E9%97%A8&diff=7806
PHP零入门
2011-02-27T09:13:18Z
<p>SnakeZero：</p>
<hr />
<div>== 序言 ==<br />
无论你以前是否有过网页编程或者其他软件开发经验，只要你会开机，本书都会让你学会如何使用PHP进行编程。<br/><br />
本书适合从头学习，并不适合作为工具书。如果你以前接触过网页编程，也请耐心从头看起，本书会以通俗易懂的事例让你了解或者说是更深入理解PHP的网页编程。<br />
<br />
== 认识浏览器与网页 ==<br />
本章节介绍浏览器访问服务器的通讯过程。GET,POST,UPDATE,DELTE四种访问方式。<br />
== 浅尝HTML ==<br />
简要的介绍HTML知识，目的是让读者对HTML代码有初步的认识。<br />
== 数据类型 ==<br />
PHP中的数据类型，基础知识。<br />
== 基本语法 ==<br />
PHP的基本语法，包括赋值，简单的数据操作。<br />
== 第一个应用程序 ==<br />
以一个应用程序带入学习，通过分析应用程序的功能来讨论如何实现，并简述思路。<br />
== 数据库 ==<br />
数据如何存储，以对象的方式看待事物。</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=PHP%E9%9B%B6%E5%85%A5%E9%97%A8&diff=7645
PHP零入门
2011-02-06T04:38:14Z
<p>SnakeZero：</p>
<hr />
<div>== 认识浏览器与网页 ==<br />
本章节介绍浏览器访问服务器的通讯过程。GET,POST,UPDATE,DELTE四种访问方式。<br />
== 浅尝HTML ==<br />
简要的介绍HTML知识，目的是让读者对HTML代码有初步的认识。<br />
== 数据类型 ==<br />
PHP中的数据类型，基础知识。<br />
== 基本语法 ==<br />
PHP的基本语法，包括赋值，简单的数据操作。<br />
== 第一个应用程序 ==<br />
以一个应用程序带入学习，通过分析应用程序的功能来讨论如何实现，并简述思路。<br />
== 数据库 ==<br />
数据如何存储，以对象的方式看待事物。</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=PHP%E9%9B%B6%E5%85%A5%E9%97%A8&diff=7644
PHP零入门
2011-02-06T04:34:22Z
<p>SnakeZero：以内容“== 认识浏览器与网页 == == 浅尝HTML == == 数据类型 == == 基本语法 == == 第一个应用程序 ==”创建新页面</p>
<hr />
<div>== 认识浏览器与网页 ==<br />
== 浅尝HTML ==<br />
== 数据类型 ==<br />
== 基本语法 ==<br />
== 第一个应用程序 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=PyGTK%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/%E7%AC%AC%E4%B8%80%E4%B8%AA%E5%9F%BA%E4%BA%8EPyGTK%E7%9A%84%E7%A8%8B%E5%BA%8F&diff=7426
PyGTK开发指南/第一个基于PyGTK的程序
2010-12-22T09:57:11Z
<p>SnakeZero：创建新页面为 ''''First steps in PyGTK''' In this part of the PyGTK programming tutorial, we will do our first steps in programming. We will create simple programs. Simple example The first…'</p>
<hr />
<div>'''First steps in PyGTK'''<br />
<br />
In this part of the PyGTK programming tutorial, we will do our first steps in programming.<br />
We will create simple programs.<br />
<br />
Simple example<br />
<br />
The first code example is a very simple one.</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=PyGTK%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97&diff=7425
PyGTK开发指南
2010-12-22T09:56:19Z
<p>SnakeZero：</p>
<hr />
<div>PyGTK tutorial<br />
{|class="Tablelist"<br />
|-<br />
|Introduction<br />
|-<br />
|[[PyGTK开发指南/第一个基于PyGTK的程序|第一个基于PyGTK的程序]]<br />
|-<br />
|Layout management<br />
|-<br />
|Menus<br />
|-<br />
|Toolbars<br />
|-<br />
|Signals & events<br />
|-<br />
|Widgets<br />
|-<br />
|Widgets II<br />
|-<br />
|Advanced Widgets<br />
|-<br />
|Dialogs<br />
|-<br />
|Pango<br />
|-<br />
|Pango II<br />
|-<br />
|Drawing with cairo<br />
|-<br />
|Drawing with cairo II<br />
|-<br />
|Snake<br />
|-<br />
|Custom widget<br />
|}</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=PyGTK%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97&diff=7423
PyGTK开发指南
2010-12-22T09:48:55Z
<p>SnakeZero：创建新页面为 'PyGTK tutorial Introduction 第一个基于PyGTK的程序 Layout management Menus Toolbars Signals & events Widgets …'</p>
<hr />
<div>PyGTK tutorial<br />
<br />
Introduction<br />
[[PyGTK开发指南|第一个基于PyGTK的程序|第一个基于PyGTK的程序]]<br />
Layout management<br />
Menus<br />
Toolbars<br />
Signals & events<br />
Widgets<br />
Widgets II<br />
Advanced Widgets<br />
Dialogs<br />
Pango<br />
Pango II<br />
Drawing with cairo<br />
Drawing with cairo II<br />
Snake<br />
Custom widget</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=%E5%88%86%E7%B1%BB:Python&diff=7422
分类:Python
2010-12-22T09:46:27Z
<p>SnakeZero：</p>
<hr />
<div>Python (发音:[ 'paiθ(ə)n; (US) 'paiθɔn ])，是一种面向对象的解释性的计算机程序设计语言，也是一种功能强大而完善的通用型语言，已经具有十多年的发展历史，成熟且稳定。Python 具有脚本语言中最丰富和强大的类库，足以支持绝大多数日常应用。<br />
<br />
Python的历史<br />
<br />
Python的创始人为Guido van Rossum。1989年圣诞节期间，在阿姆斯特丹，Guido为了打发圣诞节的无趣，决心开发一个新的脚本解释程序，做为 ABC 语言的一种继承。之所以选中 Python（大蟒蛇的意思）作为程序的名字，是因为他是一个Monty Python的飞行马戏团的爱好者。<br />
ABC是由Guido参加设计的一种教学语言。就Guido本人看来，ABC 这种语言非常优美和强大，是专门为非专业程序员设计的。但是ABC语言并没有成功，究其原因，Guido 认为是非开放造成的。Guido 决心在 Python 中避免这一错误（的确如此，Python 与其它的语言如C、C++和Java结合的非常好）。同时，他还想实现在 ABC 中闪现过但未曾实现的东西。<br />
就这样，Python在Guido手中诞生了。实际上，第一个实现是在Mac机上。可以说，Python是从ABC发展起来，主要受到了Modula-3（另一种相当优美且强大的语言，为小型团体所设计的）的影响。并且结合了Unix shell和C的习惯。<br />
<br />
<br />
*[http://www.blueidea.com/tech/program/2007/5181.asp (Python)web.py的简介 ]<br />
<br />
[[PyGTK开发指南]]</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss&diff=7066
Protoss
2010-08-31T23:53:07Z
<p>SnakeZero：/* 附录 C. 更新记录 */</p>
<hr />
<div>Protoss是一款轻量级的PHP框架，目前由Snake.Zero进行日常维护。<br />
{{notice|content=Protoss读作：['prɔtɔs]。Protos在希腊语中是“第一”的意思,而“proto-”也是英文中表示"第一 主要"之义的前缀。}}<br />
<br />
== 框架简介 ==<br />
=== [[Protoss/简介|框架介绍]] ===<br />
Protoss是一款轻量的PHP框架，前身Snake Framework，历经5年积累，纯构思时间超过2年。Protoss的编写目的，是为了解决开发中的代码不规范、流程不规范、文档不规范这些问题，因为他和一些第三方助手类或快速开发框架相比，更多的'''不是'''提供了什么，反而更多是'''什么不能做，不能怎么做'''。<br />
<br />
Protoss实现的一个真正框架该有的“框架”效果。和很多以快速开发的框架一样，Protoss提供了一些助手类，这些类大大减小了开发中重复劳动的部分。然而更重要的是，它是一款以约束开发行为为目的的框架项目。它在文件、类、函数、数据表的设计上，做了相对严格的限制，使用户项目整体简洁、清晰而且方便阅读。<br />
对于员工流动大的公司，减少了新员工的学习和交流成本。<br />
<br />
另：在设计之初，Protoss的目的是成为一个真正意义上的框架，因此不光包括代码方面，同时还包括了日常文档，工作流程的规范化。但是目前而言，在一些小公司中，这些相对复杂的规范化流程的推进还是有些困难。<br />
<br />
{{notice|content=完整版概述：[[Protoss/简介|Protoss is not a underwear!]]<br/>推荐阅读：[[Protoss/运行|为什么Protoss会更少的干涉业务逻辑]]}}<br />
<br />
=== 框架特性 ===<br />
*摈弃PHP的MySQL扩展，转而使用更高效且面向对象的MySQLi<br />
*Model层被重视，不再是简单的ORM映射，而是真正意义上的数据模型层<br />
*相对严格的命名规范，代码更具可读性<br />
*更安全的访问权限控制<br />
*更强的代码生成工具<br />
<br />
== 快速入门指南 ==<br />
本快歌入门指南假定读者对PHP,MySQL有一定基础。知道MVC或有其他框架开发经验为佳，但是在后面也会有一定介绍。<br />
=== 轻松编程从这里开始 ===<br />
==== [[Protoss/MVC简介|MVC简介]] ====<br />
==== [[Protoss/目录结构|基于Protoss的项目特征和目录结构]] ====<br />
==== [[Protoss/运行|轻松访问到控制器]] ====<br />
<br />
=== Hello world，我的第一个应用软件 ===<br />
==== [[Protoss/控制器|编写控制器]] ====<br />
==== [[Protoss/控制器/动作|控制器中的Action]] ====<br />
==== [[Protoss/控制器/内部方法|我有许多小秘密--private和protected]] ====<br />
<br />
=== 模板引擎 ===<br />
==== [[Protoss/模板/载入模板|很给力！自动引入模板]] ====<br />
==== [[Protoss/模板|视图也可以继承]] ====<br />
==== [[Protoss/模板|看，这些元素其实是可以拆分和复用的]] ====<br />
<br />
=== [[Protoss/模型|了解数据模型]] ===<br />
==== [[Protoss/模型/mysqli|建立MySQLi数据模型]] ====<br />
==== [[Protoss/模型/rest|Rest风格的数据模型]] ====<br />
<br />
== 项目开发权威指南 ==<br />
<br />
=== [[Protoss权威指南/名词解释|名词解释]] ===<br />
<br />
== 附录 ==<br />
=== 附录 A. 代码编写与开发流程规范 ===<br />
==== [[Protoss/规范/概述|概述]] ====<br />
Subversion是一个自由/开源版本控制系统，它管理文件和目录可以超越时间。[[Protoss/规范/概述|更多(利用版本控制进行协助开发)]]<br />
<br />
==== [[Protoss/规范/代码规范|Protoss代码编写规范]] ====<br />
【[[Protoss/规范/代码规范|点此阅读Protoss代码编写规范，推荐]]】<br />
<br />
==== 工作模型 ====<br />
checkout（检出）项目<br />
更新文件或目录 update<br />
修改文件或目录 commit(提交)变更<br />
增加文件或目录 add(增加) <br />
文件或目录 commit(提交)<br />
删除文件或目录 commit(提交)上一级目录<br />
<br />
==== [[Protoss/规范/操作指南|操作指南]] ====<br />
当你在为项目工作时，首先请更新你的工作拷贝来获取那些你上次更新以来其他开发人员对项目做的新改动。[[Protoss/规范/操作指南|更多]]<br />
<br />
==== 开发与测试部署流程 ====<br />
开发人员使用trunk目录进行当前版本开发.在模拟环境中进行单元测试.[[Protoss/规范/测试和部署|更多]]<br />
==== [[Protoss/规范/核心提示|核心提示]] ====<br />
*负责而谨慎地提交自己的代码<br />
*保持原子性的提交<br />
*不要提交自动生成的文件<br />
*不要提交不能通过编译的代码<br />
*不要提交自己不明白的代码<br />
*提前宣布自己的工作计划<br />
*对提交的信息采用明晰的标注<br />
<br />
=== 附录 B. 版权信息 ===<br />
以下版权信息适用于Protoss项目，包括但不限于代码部分。（注：代码仅指Protoss框架代码，不包含开发人员基于此框架的应用程序，各应用程序开发者享有该程序代码的一切权利）<br />
<br />
Copyright &copy; 2009-2010 Snake.Zero<br />
<br />
=== 附录 C. 更新记录 ===<br />
* 2009年6月&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Protoss 0.1beta Protoss诞生<br/><br />
* 2010年6月&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Protoss 0.5beta 经过一年的开发和测试，第一个稳定版本<br/><br />
* 2010年7月24日&nbsp; Protoss 0.5.1 Mysqli模型驱动新特性<br/></div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss&diff=7065
Protoss
2010-08-31T23:51:32Z
<p>SnakeZero：/* 附录 C. 更新记录 */</p>
<hr />
<div>Protoss是一款轻量级的PHP框架，目前由Snake.Zero进行日常维护。<br />
{{notice|content=Protoss读作：['prɔtɔs]。Protos在希腊语中是“第一”的意思,而“proto-”也是英文中表示"第一 主要"之义的前缀。}}<br />
<br />
== 框架简介 ==<br />
=== [[Protoss/简介|框架介绍]] ===<br />
Protoss是一款轻量的PHP框架，前身Snake Framework，历经5年积累，纯构思时间超过2年。Protoss的编写目的，是为了解决开发中的代码不规范、流程不规范、文档不规范这些问题，因为他和一些第三方助手类或快速开发框架相比，更多的'''不是'''提供了什么，反而更多是'''什么不能做，不能怎么做'''。<br />
<br />
Protoss实现的一个真正框架该有的“框架”效果。和很多以快速开发的框架一样，Protoss提供了一些助手类，这些类大大减小了开发中重复劳动的部分。然而更重要的是，它是一款以约束开发行为为目的的框架项目。它在文件、类、函数、数据表的设计上，做了相对严格的限制，使用户项目整体简洁、清晰而且方便阅读。<br />
对于员工流动大的公司，减少了新员工的学习和交流成本。<br />
<br />
另：在设计之初，Protoss的目的是成为一个真正意义上的框架，因此不光包括代码方面，同时还包括了日常文档，工作流程的规范化。但是目前而言，在一些小公司中，这些相对复杂的规范化流程的推进还是有些困难。<br />
<br />
{{notice|content=完整版概述：[[Protoss/简介|Protoss is not a underwear!]]<br/>推荐阅读：[[Protoss/运行|为什么Protoss会更少的干涉业务逻辑]]}}<br />
<br />
=== 框架特性 ===<br />
*摈弃PHP的MySQL扩展，转而使用更高效且面向对象的MySQLi<br />
*Model层被重视，不再是简单的ORM映射，而是真正意义上的数据模型层<br />
*相对严格的命名规范，代码更具可读性<br />
*更安全的访问权限控制<br />
*更强的代码生成工具<br />
<br />
== 快速入门指南 ==<br />
本快歌入门指南假定读者对PHP,MySQL有一定基础。知道MVC或有其他框架开发经验为佳，但是在后面也会有一定介绍。<br />
=== 轻松编程从这里开始 ===<br />
==== [[Protoss/MVC简介|MVC简介]] ====<br />
==== [[Protoss/目录结构|基于Protoss的项目特征和目录结构]] ====<br />
==== [[Protoss/运行|轻松访问到控制器]] ====<br />
<br />
=== Hello world，我的第一个应用软件 ===<br />
==== [[Protoss/控制器|编写控制器]] ====<br />
==== [[Protoss/控制器/动作|控制器中的Action]] ====<br />
==== [[Protoss/控制器/内部方法|我有许多小秘密--private和protected]] ====<br />
<br />
=== 模板引擎 ===<br />
==== [[Protoss/模板/载入模板|很给力！自动引入模板]] ====<br />
==== [[Protoss/模板|视图也可以继承]] ====<br />
==== [[Protoss/模板|看，这些元素其实是可以拆分和复用的]] ====<br />
<br />
=== [[Protoss/模型|了解数据模型]] ===<br />
==== [[Protoss/模型/mysqli|建立MySQLi数据模型]] ====<br />
==== [[Protoss/模型/rest|Rest风格的数据模型]] ====<br />
<br />
== 项目开发权威指南 ==<br />
<br />
=== [[Protoss权威指南/名词解释|名词解释]] ===<br />
<br />
== 附录 ==<br />
=== 附录 A. 代码编写与开发流程规范 ===<br />
==== [[Protoss/规范/概述|概述]] ====<br />
Subversion是一个自由/开源版本控制系统，它管理文件和目录可以超越时间。[[Protoss/规范/概述|更多(利用版本控制进行协助开发)]]<br />
<br />
==== [[Protoss/规范/代码规范|Protoss代码编写规范]] ====<br />
【[[Protoss/规范/代码规范|点此阅读Protoss代码编写规范，推荐]]】<br />
<br />
==== 工作模型 ====<br />
checkout（检出）项目<br />
更新文件或目录 update<br />
修改文件或目录 commit(提交)变更<br />
增加文件或目录 add(增加) <br />
文件或目录 commit(提交)<br />
删除文件或目录 commit(提交)上一级目录<br />
<br />
==== [[Protoss/规范/操作指南|操作指南]] ====<br />
当你在为项目工作时，首先请更新你的工作拷贝来获取那些你上次更新以来其他开发人员对项目做的新改动。[[Protoss/规范/操作指南|更多]]<br />
<br />
==== 开发与测试部署流程 ====<br />
开发人员使用trunk目录进行当前版本开发.在模拟环境中进行单元测试.[[Protoss/规范/测试和部署|更多]]<br />
==== [[Protoss/规范/核心提示|核心提示]] ====<br />
*负责而谨慎地提交自己的代码<br />
*保持原子性的提交<br />
*不要提交自动生成的文件<br />
*不要提交不能通过编译的代码<br />
*不要提交自己不明白的代码<br />
*提前宣布自己的工作计划<br />
*对提交的信息采用明晰的标注<br />
<br />
=== 附录 B. 版权信息 ===<br />
以下版权信息适用于Protoss项目，包括但不限于代码部分。（注：代码仅指Protoss框架代码，不包含开发人员基于此框架的应用程序，各应用程序开发者享有该程序代码的一切权利）<br />
<br />
Copyright &copy; 2009-2010 Snake.Zero<br />
<br />
=== 附录 C. 更新记录 ===<br />
2009年6月 Protoss 0.1beta Protoss诞生<br/><br />
2010年6月 Protoss 0.5beta 经过一年的开发和测试，第一个稳定版本<br/><br />
2010年7月24日 Protoss 0.5.1 Mysqli模型驱动新特性<br/></div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7061
Protoss/规范/代码规范
2010-08-23T01:45:58Z
<p>SnakeZero：</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
<font color="#FF0000">规范的代码是从程序员到高级程序员的必经之路，对企业而言，高质量的代码是可复用和可再生的，而那些看起来吃力的“一次性”代码无疑给企业带来了巨大的隐性成本。企业愿意付更高的报酬聘请那些高级程序员，是可以帮他们减少开发成本，尤其是时间。</font><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 基本命名规则 ==<br />
=== 全局变量和函数命名等 ===<br />
* 变量<br />
如果你需要定义一个全局变量的话,应当以美元符号加下划线“$_”开头，后接包名。例如,PEAR包中一个变量就作：$_PEAR_destructor_object_list。<br/><br />
<br/><br />
* 函数的命名<br />
在PEAR的定义中，我们应当使用“驼峰”写法的代码规则，以包名加下划线为前缀。我们以“XML_RPC_serializeData()”来分析。<br/><br />
在命名中缩写词应当全部大写，如上面的XML和RPC，又如Protoss中的“RBAC”(Role-Based Access Control)。如果是几个单词连着写，那么第一个单词应当首字母小写，后面的单词首字母大写，如上面的serializeData。<br/><br />
<br/><br />
* 类中的方法<br />
在类中，public属性的变量或者参数应该以美元符加小写开头变量名来书写，如“$content”，“$mysqlResult”，“$protoss”。<br/><br />
而私有的方法(private)或变量名应该冠以下划线，如“$_mysqlHandle”，“_processMethod()”，“_sort()”，“_intTree()”。<br/><br />
而protected则和public一样，不能加上下划线。<br/><br />
<br/><br />
* 常量<br />
常量的命名应该为全大写，如：DB_DATASOURCENAME 、 SERVICES_AMAZON_S3_LICENSEKEY<br />
<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
所有需要包含在PEAR核心发布的PHP代码文件，在文件开始的时候，你必须加入以下的注释声明：<br />
<source lang="php">/* vim: set expandtab tabstop=4 shiftwidth=4: */<br />
// +----------------------------------------------------------------------+<br />
// | PHP version 4.0 |<br />
// +----------------------------------------------------------------------+<br />
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |<br />
// +----------------------------------------------------------------------+<br />
// | This source file is subject to version 2.0 of the PHP license, |<br />
// | that is bundled with this package in the file LICENSE, and is |<br />
// | available at through the world-wide-web at |<br />
// | http://www.php.net/license/2_02.txt. |<br />
// | If you did not receive a copy of the PHP license and are unable to |<br />
// | obtain it through the world-wide-web, please send a note to |<br />
// | license@php.net so we can mail you a copy immediately. |<br />
// +----------------------------------------------------------------------+<br />
// | Authors: 组织机构名称 |<br />
// | Snake.Zero -- Orochi the Great |<br />
// +----------------------------------------------------------------------+<br />
//<br />
// $Id$<br />
</source><br />
对于不在PEAR核心代码库中的文件，建议你也在文件的开始处有这样一个类似的注释块，标明版权，协议，作者等等。同时也在第一行加入VIM的MODELINE，这样在VIM中能够保持PEAR的代码风格。<br/><br />
* CVS标记：<br />
如上面所展示那样，在每个文件中加入CVS的ID标记，如果你编辑或修改的文件中没有这个标记，那么请加入，或者是替换原文件中相类似的表现形式（如"Last modified"等等）<br />
* URL样本：<br />
你可以参照RFC 2606,使用"www.example.com"作为所有的URL样本。<br />
* 常量命名：<br />
常量应该尽量使用大写，为了便于理解，使用下划线分割每个单词。同时，你应该常量所在的包名或者是类名作为前缀。比如，对于Bug类中常量应该以Bug_开始。以上是PEAR的编码规则，详细的编码规则可以参考PEAR中的CODING_STANDDARD文件的说明。为了更好地理解这些编码规则，你也可以参考一下现有PEAR核心模块的代码。<br />
<br />
== 文件的相关规范 ==<br />
* 所有文件必须是unix文件格式<br />
* 所有文件编码必须是UTF-8<br />
* 文件以ASCII码来存储<br />
<br />
== PHP代码标记 ==<br />
以PEAR的方式来书写时：<br/><br />
任何时候都要使用<?php ?>定义你的php代码，而不要简单地使用<? ?>,这样可以保证PEAR的兼容性，也利于跨平台的移植。<br />
{{notice|content=事实证明，以“<?php”开头更加规范，但是之后的?>确实可以省略。那样可以减少许多无法预期的意外输出。<br/>在PHP中，不使用“?>”结尾不会引起错误，哪怕连NOTICE也没有。}}<br />
<br />
== 全文示例 ==<br />
<source lang="php"><br />
<?php<br />
<br />
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */<br />
<br />
/**<br />
* Short description for file<br />
*<br />
* Long description for file (if any)...<br />
*<br />
* PHP version 5<br />
*<br />
* LICENSE: This source file is subject to version 3.01 of the PHP license<br />
* that is available through the world-wide-web at the following URI:<br />
* http://www.php.net/license/3_01.txt. If you did not receive a copy of<br />
* the PHP License and are unable to obtain it through the web, please<br />
* send a note to license@php.net so we can mail you a copy immediately.<br />
*<br />
* @category CategoryName<br />
* @package PackageName<br />
* @author Original Author <author@example.com><br />
* @author Another Author <another@example.com><br />
* @copyright 1997-2005 The PHP Group<br />
* @license http://www.php.net/license/3_01.txt PHP License 3.01<br />
* @version CVS: <?php<br />
$<br />
?> Id:$<br />
* @link http://pear.php.net/package/PackageName<br />
* @see NetOther, Net_Sample::Net_Sample()<br />
* @since File available since Release 1.2.0<br />
* @deprecated File deprecated in Release 2.0.0<br />
*/<br />
<br />
/**<br />
* This is a "Docblock Comment," also known as a "docblock." The class'<br />
* docblock, below, contains a complete description of how to write these.<br />
*/<br />
require_once 'PEAR.php';<br />
<br />
// {{{ constants<br />
<br />
/**<br />
* Methods return this if they succeed<br />
*/<br />
define('NET_SAMPLE_OK', 1);<br />
<br />
// }}}<br />
// {{{ GLOBALS<br />
<br />
/**<br />
* The number of objects created<br />
* @global int $GLOBALS['_NET_SAMPLE_Count']<br />
*/<br />
$GLOBALS['_NET_SAMPLE_Count'] = 0;<br />
<br />
// }}}<br />
// {{{ Net_Sample<br />
<br />
/**<br />
* An example of how to write code to PEAR's standards<br />
*<br />
* Docblock comments start with "/**" at the top. Notice how the "/"<br />
* lines up with the normal indenting and the asterisks on subsequent rows<br />
* are in line with the first asterisk. The last line of comment text<br />
* should be immediately followed on the next line by the closing asterisk<br />
* and slash and then the item you are commenting on should be on the next<br />
* line below that. Don't add extra lines. Please put a blank line<br />
* between paragraphs as well as between the end of the description and<br />
* the start of the @tags. Wrap comments before 80 columns in order to<br />
* ease readability for a wide variety of users.<br />
*<br />
* Docblocks can only be used for programming constructs which allow them<br />
* (classes, properties, methods, defines, includes, globals). See the<br />
* phpDocumentor documentation for more information.<br />
* http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html<br />
*<br />
* The Javadoc Style Guide is an excellent resource for figuring out<br />
* how to say what needs to be said in docblock comments. Much of what is<br />
* written here is a summary of what is found there, though there are some<br />
* cases where what's said here overrides what is said there.<br />
* http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#styleguide<br />
*<br />
* The first line of any docblock is the summary. Make them one short<br />
* sentence, without a period at the end. Summaries for classes, properties<br />
* and constants should omit the subject and simply state the object,<br />
* because they are describing things rather than actions or behaviors.<br />
*<br />
* Below are the tags commonly used for classes. @category through @version<br />
* are required. The remainder should only be used when necessary.<br />
* Please use them in the order they appear here. phpDocumentor has<br />
* several other tags available, feel free to use them.<br />
*<br />
* @category CategoryName<br />
* @package PackageName<br />
* @author Original Author <author@example.com><br />
* @author Another Author <another@example.com><br />
* @copyright 1997-2005 The PHP Group<br />
* @license http://www.php.net/license/3_01.txt PHP License 3.01<br />
* @version Release: @package_version@<br />
* @link http://pear.php.net/package/PackageName<br />
* @see NetOther, Net_Sample::Net_Sample()<br />
* @since Class available since Release 1.2.0<br />
* @deprecated Class deprecated in Release 2.0.0<br />
*/<br />
class Net_Sample<br />
{<br />
// {{{ properties<br />
<br />
/**<br />
* The status of foo's universe<br />
*<br />
* Potential values are 'good', 'fair', 'poor' and 'unknown'.<br />
*<br />
* @var string<br />
*/<br />
var $foo = 'unknown';<br />
<br />
/**<br />
* The status of life<br />
*<br />
* Note that names of private properties or methods must be<br />
* preceeded by an underscore.<br />
*<br />
* @var bool<br />
* @access private<br />
*/<br />
var $_good = true;<br />
<br />
// }}}<br />
// {{{ setFoo()<br />
<br />
/**<br />
* Registers the status of foo's universe<br />
*<br />
* Summaries for methods should use 3rd person declarative rather<br />
* than 2nd person imperative, beginning with a verb phrase.<br />
*<br />
* Summaries should add description beyond the method's name. The<br />
* best method names are "self-documenting", meaning they tell you<br />
* basically what the method does. If the summary merely repeats<br />
* the method name in sentence form, it is not providing more<br />
* information.<br />
*<br />
* Summary Examples:<br />
* + Sets the label (preferred)<br />
* + Set the label (avoid)<br />
* + This method sets the label (avoid)<br />
*<br />
* Below are the tags commonly used for methods. A @param tag is<br />
* required for each parameter the method has. The @return<br />
* and @access tags are mandatory. The @throws tag is required if<br />
* the method uses exceptions. @static is required if the method can<br />
* be called statically. The remainder should only be used when<br />
* necessary. Please use them in the order they appear here.<br />
* phpDocumentor has several other tags available, feel free to use<br />
* them.<br />
*<br />
* The @param tag contains the data type, then the parameter's<br />
* name, followed by a description. By convention, the first noun in<br />
* the description is the data type of the parameter. Articles like<br />
* "a", "an", and "the" can precede the noun. The descriptions<br />
* should start with a phrase. If further description is necessary,<br />
* follow with sentences. Having two spaces between the name and the<br />
* description aids readability.<br />
*<br />
* When writing a phrase, do not capitalize and do not end with a<br />
* period:<br />
* + the string to be tested<br />
*<br />
* When writing a phrase followed by a sentence, do not capitalize the<br />
* phrase, but end it with a period to distinguish it from the start<br />
* of the next sentence:<br />
* + the string to be tested. Must use UTF-8 encoding.<br />
*<br />
* Return tags should contain the data type then a description of<br />
* the data returned. The data type can be any of PHP's data types<br />
* (int, float, bool, string, array, object, resource, mixed)<br />
* and should contain the type primarily returned. For example, if<br />
* a method returns an object when things work correctly but false<br />
* when an error happens, say 'object' rather than 'mixed.' Use<br />
* 'void' if nothing is returned.<br />
*<br />
* Here's an example of how to format examples:<br />
* <code><br />
* require_once 'Net/Sample.php';<br />
*<br />
* $s = new Net_Sample();<br />
* if (PEAR::isError($s)) {<br />
* echo $s->getMessage() . "\n";<br />
* }<br />
* </code><br />
*<br />
* Here is an example for non-php example or sample:<br />
* <samp><br />
* pear install net_sample<br />
* </samp><br />
*<br />
* @param string $arg1 the string to quote<br />
* @param int $arg2 an integer of how many problems happened.<br />
* Indent to the description's starting point<br />
* for long ones.<br />
*<br />
* @return int the integer of the set mode used. FALSE if foo<br />
* foo could not be set.<br />
* @throws exceptionclass [description]<br />
*<br />
* @access public<br />
* @static<br />
* @see Net_Sample::$foo, Net_Other::someMethod()<br />
* @since Method available since Release 1.2.0<br />
* @deprecated Method deprecated in Release 2.0.0<br />
*/<br />
function setFoo($arg1, $arg2 = 0)<br />
{<br />
/*<br />
* This is a "Block Comment." The format is the same as<br />
* Docblock Comments except there is only one asterisk at the<br />
* top. phpDocumentor doesn't parse these.<br />
*/<br />
if ($arg1 == 'good' || $arg1 == 'fair') {<br />
$this->foo = $arg1;<br />
return 1;<br />
} elseif ($arg1 == 'poor' && $arg2 > 1) {<br />
$this->foo = 'poor';<br />
return 2;<br />
} else {<br />
return false;<br />
}<br />
}<br />
<br />
// }}}<br />
}<br />
<br />
// }}}<br />
<br />
/*<br />
* Local variables:<br />
* tab-width: 4<br />
* c-basic-offset: 4<br />
* c-hanging-comment-ender-p: nil<br />
* End:<br />
*/<br />
<br />
?></source></div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss&diff=7054
Protoss
2010-08-20T04:46:07Z
<p>SnakeZero：/* Protoss代码编写规范 */</p>
<hr />
<div>Protoss是一款轻量级的PHP框架，目前由Snake.Zero进行日常维护。<br />
{{notice|content=Protoss读作：['prɔtɔs]。Protos在希腊语中是“第一”的意思,而“proto-”也是英文中表示"第一 主要"之义的前缀。}}<br />
<br />
== 框架简介 ==<br />
=== [[Protoss/简介|框架介绍]] ===<br />
Protoss是一款轻量的PHP框架，前身Snake Framework，历经5年积累，纯构思时间超过2年。Protoss的编写目的，是为了解决开发中的代码不规范、流程不规范、文档不规范这些问题，因为他和一些第三方助手类或快速开发框架相比，更多的'''不是'''提供了什么，反而更多是'''什么不能做，不能怎么做'''。<br />
<br />
Protoss实现的一个真正框架该有的“框架”效果。和很多以快速开发的框架一样，Protoss提供了一些助手类，这些类大大减小了开发中重复劳动的部分。然而更重要的是，它是一款以约束开发行为为目的的框架项目。它在文件、类、函数、数据表的设计上，做了相对严格的限制，使用户项目整体简洁、清晰而且方便阅读。<br />
对于员工流动大的公司，减少了新员工的学习和交流成本。<br />
<br />
另：在设计之初，Protoss的目的是成为一个真正意义上的框架，因此不光包括代码方面，同时还包括了日常文档，工作流程的规范化。但是目前而言，在一些小公司中，这些相对复杂的规范化流程的推进还是有些困难。<br />
<br />
{{notice|content=完整版概述：[[Protoss/简介|Protoss is not a underwear!]]<br/>推荐阅读：[[Protoss/运行|为什么Protoss会更少的干涉业务逻辑]]}}<br />
<br />
=== 框架特性 ===<br />
*摈弃PHP的MySQL扩展，转而使用更高效且面向对象的MySQLi<br />
*Model层被重视，不再是简单的ORM映射，而是真正意义上的数据模型层<br />
*相对严格的命名规范，代码更具可读性<br />
*更安全的访问权限控制<br />
*更强的代码生成工具<br />
<br />
== 快速入门指南 ==<br />
本快歌入门指南假定读者对PHP,MySQL有一定基础。知道MVC或有其他框架开发经验为佳，但是在后面也会有一定介绍。<br />
=== 轻松编程从这里开始 ===<br />
==== [[Protoss/MVC简介|MVC简介]] ====<br />
==== [[Protoss/目录结构|基于Protoss的项目特征和目录结构]] ====<br />
==== [[Protoss/运行|轻松访问到控制器]] ====<br />
<br />
=== Hello world，我的第一个应用软件 ===<br />
==== [[Protoss/控制器|编写控制器]] ====<br />
==== [[Protoss/控制器/动作|控制器中的Action]] ====<br />
==== [[Protoss/控制器/内部方法|我有许多小秘密--private和protected]] ====<br />
<br />
=== 模板引擎 ===<br />
==== [[Protoss/模板/载入模板|很给力！自动引入模板]] ====<br />
==== [[Protoss/模板|视图也可以继承]] ====<br />
==== [[Protoss/模板|看，这些元素其实是可以拆分和复用的]] ====<br />
<br />
=== [[Protoss/模型|了解数据模型]] ===<br />
==== [[Protoss/模型/mysqli|建立MySQLi数据模型]] ====<br />
==== [[Protoss/模型/rest|Rest风格的数据模型]] ====<br />
<br />
== 项目开发权威指南 ==<br />
<br />
=== [[Protoss权威指南/名词解释|名词解释]] ===<br />
<br />
== 附录 ==<br />
=== 附录 A. 代码编写与开发流程规范 ===<br />
==== [[Protoss/规范/概述|概述]] ====<br />
Subversion是一个自由/开源版本控制系统，它管理文件和目录可以超越时间。[[Protoss/规范/概述|更多(利用版本控制进行协助开发)]]<br />
<br />
==== [[Protoss/规范/代码规范|Protoss代码编写规范]] ====<br />
【[[Protoss/规范/代码规范|点此阅读Protoss代码编写规范，推荐]]】<br />
<br />
==== 工作模型 ====<br />
checkout（检出）项目<br />
更新文件或目录 update<br />
修改文件或目录 commit(提交)变更<br />
增加文件或目录 add(增加) <br />
文件或目录 commit(提交)<br />
删除文件或目录 commit(提交)上一级目录<br />
<br />
==== [[Protoss/规范/操作指南|操作指南]] ====<br />
当你在为项目工作时，首先请更新你的工作拷贝来获取那些你上次更新以来其他开发人员对项目做的新改动。[[Protoss/规范/操作指南|更多]]<br />
<br />
==== 开发与测试部署流程 ====<br />
开发人员使用trunk目录进行当前版本开发.在模拟环境中进行单元测试.[[Protoss/规范/测试和部署|更多]]<br />
==== [[Protoss/规范/核心提示|核心提示]] ====<br />
*负责而谨慎地提交自己的代码<br />
*保持原子性的提交<br />
*不要提交自动生成的文件<br />
*不要提交不能通过编译的代码<br />
*不要提交自己不明白的代码<br />
*提前宣布自己的工作计划<br />
*对提交的信息采用明晰的标注<br />
<br />
=== 附录 B. 版权信息 ===<br />
以下版权信息适用于Protoss项目，包括但不限于代码部分。（注：代码仅指Protoss框架代码，不包含开发人员基于此框架的应用程序，各应用程序开发者享有该程序代码的一切权利）<br />
<br />
Copyright &copy; 2009-2010 Snake.Zero<br />
<br />
=== 附录 C. 更新记录 ===<br />
2009年6月 Protoss 0.1beta Protoss诞生<br/><br />
2010年6月 Protoss 0.5beta 经过一年的开发和测试，第一个稳定版本<br/><br />
2020年7月24日 Protoss 0.5.1 Mysqli模型驱动新特性<br/></div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss&diff=7053
Protoss
2010-08-20T04:45:39Z
<p>SnakeZero：/* Protoss代码编写规范 */</p>
<hr />
<div>Protoss是一款轻量级的PHP框架，目前由Snake.Zero进行日常维护。<br />
{{notice|content=Protoss读作：['prɔtɔs]。Protos在希腊语中是“第一”的意思,而“proto-”也是英文中表示"第一 主要"之义的前缀。}}<br />
<br />
== 框架简介 ==<br />
=== [[Protoss/简介|框架介绍]] ===<br />
Protoss是一款轻量的PHP框架，前身Snake Framework，历经5年积累，纯构思时间超过2年。Protoss的编写目的，是为了解决开发中的代码不规范、流程不规范、文档不规范这些问题，因为他和一些第三方助手类或快速开发框架相比，更多的'''不是'''提供了什么，反而更多是'''什么不能做，不能怎么做'''。<br />
<br />
Protoss实现的一个真正框架该有的“框架”效果。和很多以快速开发的框架一样，Protoss提供了一些助手类，这些类大大减小了开发中重复劳动的部分。然而更重要的是，它是一款以约束开发行为为目的的框架项目。它在文件、类、函数、数据表的设计上，做了相对严格的限制，使用户项目整体简洁、清晰而且方便阅读。<br />
对于员工流动大的公司，减少了新员工的学习和交流成本。<br />
<br />
另：在设计之初，Protoss的目的是成为一个真正意义上的框架，因此不光包括代码方面，同时还包括了日常文档，工作流程的规范化。但是目前而言，在一些小公司中，这些相对复杂的规范化流程的推进还是有些困难。<br />
<br />
{{notice|content=完整版概述：[[Protoss/简介|Protoss is not a underwear!]]<br/>推荐阅读：[[Protoss/运行|为什么Protoss会更少的干涉业务逻辑]]}}<br />
<br />
=== 框架特性 ===<br />
*摈弃PHP的MySQL扩展，转而使用更高效且面向对象的MySQLi<br />
*Model层被重视，不再是简单的ORM映射，而是真正意义上的数据模型层<br />
*相对严格的命名规范，代码更具可读性<br />
*更安全的访问权限控制<br />
*更强的代码生成工具<br />
<br />
== 快速入门指南 ==<br />
本快歌入门指南假定读者对PHP,MySQL有一定基础。知道MVC或有其他框架开发经验为佳，但是在后面也会有一定介绍。<br />
=== 轻松编程从这里开始 ===<br />
==== [[Protoss/MVC简介|MVC简介]] ====<br />
==== [[Protoss/目录结构|基于Protoss的项目特征和目录结构]] ====<br />
==== [[Protoss/运行|轻松访问到控制器]] ====<br />
<br />
=== Hello world，我的第一个应用软件 ===<br />
==== [[Protoss/控制器|编写控制器]] ====<br />
==== [[Protoss/控制器/动作|控制器中的Action]] ====<br />
==== [[Protoss/控制器/内部方法|我有许多小秘密--private和protected]] ====<br />
<br />
=== 模板引擎 ===<br />
==== [[Protoss/模板/载入模板|很给力！自动引入模板]] ====<br />
==== [[Protoss/模板|视图也可以继承]] ====<br />
==== [[Protoss/模板|看，这些元素其实是可以拆分和复用的]] ====<br />
<br />
=== [[Protoss/模型|了解数据模型]] ===<br />
==== [[Protoss/模型/mysqli|建立MySQLi数据模型]] ====<br />
==== [[Protoss/模型/rest|Rest风格的数据模型]] ====<br />
<br />
== 项目开发权威指南 ==<br />
<br />
=== [[Protoss权威指南/名词解释|名词解释]] ===<br />
<br />
== 附录 ==<br />
=== 附录 A. 代码编写与开发流程规范 ===<br />
==== [[Protoss/规范/概述|概述]] ====<br />
Subversion是一个自由/开源版本控制系统，它管理文件和目录可以超越时间。[[Protoss/规范/概述|更多(利用版本控制进行协助开发)]]<br />
<br />
==== [[Protoss/规范/代码规范|Protoss代码编写规范]] ====<br />
【[[点此阅读Protoss/规范/代码规范|Protoss代码编写规范，推荐]]】<br />
<br />
==== 工作模型 ====<br />
checkout（检出）项目<br />
更新文件或目录 update<br />
修改文件或目录 commit(提交)变更<br />
增加文件或目录 add(增加) <br />
文件或目录 commit(提交)<br />
删除文件或目录 commit(提交)上一级目录<br />
<br />
==== [[Protoss/规范/操作指南|操作指南]] ====<br />
当你在为项目工作时，首先请更新你的工作拷贝来获取那些你上次更新以来其他开发人员对项目做的新改动。[[Protoss/规范/操作指南|更多]]<br />
<br />
==== 开发与测试部署流程 ====<br />
开发人员使用trunk目录进行当前版本开发.在模拟环境中进行单元测试.[[Protoss/规范/测试和部署|更多]]<br />
==== [[Protoss/规范/核心提示|核心提示]] ====<br />
*负责而谨慎地提交自己的代码<br />
*保持原子性的提交<br />
*不要提交自动生成的文件<br />
*不要提交不能通过编译的代码<br />
*不要提交自己不明白的代码<br />
*提前宣布自己的工作计划<br />
*对提交的信息采用明晰的标注<br />
<br />
=== 附录 B. 版权信息 ===<br />
以下版权信息适用于Protoss项目，包括但不限于代码部分。（注：代码仅指Protoss框架代码，不包含开发人员基于此框架的应用程序，各应用程序开发者享有该程序代码的一切权利）<br />
<br />
Copyright &copy; 2009-2010 Snake.Zero<br />
<br />
=== 附录 C. 更新记录 ===<br />
2009年6月 Protoss 0.1beta Protoss诞生<br/><br />
2010年6月 Protoss 0.5beta 经过一年的开发和测试，第一个稳定版本<br/><br />
2020年7月24日 Protoss 0.5.1 Mysqli模型驱动新特性<br/></div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss&diff=7052
Protoss
2010-08-20T04:45:20Z
<p>SnakeZero：</p>
<hr />
<div>Protoss是一款轻量级的PHP框架，目前由Snake.Zero进行日常维护。<br />
{{notice|content=Protoss读作：['prɔtɔs]。Protos在希腊语中是“第一”的意思,而“proto-”也是英文中表示"第一 主要"之义的前缀。}}<br />
<br />
== 框架简介 ==<br />
=== [[Protoss/简介|框架介绍]] ===<br />
Protoss是一款轻量的PHP框架，前身Snake Framework，历经5年积累，纯构思时间超过2年。Protoss的编写目的，是为了解决开发中的代码不规范、流程不规范、文档不规范这些问题，因为他和一些第三方助手类或快速开发框架相比，更多的'''不是'''提供了什么，反而更多是'''什么不能做，不能怎么做'''。<br />
<br />
Protoss实现的一个真正框架该有的“框架”效果。和很多以快速开发的框架一样，Protoss提供了一些助手类，这些类大大减小了开发中重复劳动的部分。然而更重要的是，它是一款以约束开发行为为目的的框架项目。它在文件、类、函数、数据表的设计上，做了相对严格的限制，使用户项目整体简洁、清晰而且方便阅读。<br />
对于员工流动大的公司，减少了新员工的学习和交流成本。<br />
<br />
另：在设计之初，Protoss的目的是成为一个真正意义上的框架，因此不光包括代码方面，同时还包括了日常文档，工作流程的规范化。但是目前而言，在一些小公司中，这些相对复杂的规范化流程的推进还是有些困难。<br />
<br />
{{notice|content=完整版概述：[[Protoss/简介|Protoss is not a underwear!]]<br/>推荐阅读：[[Protoss/运行|为什么Protoss会更少的干涉业务逻辑]]}}<br />
<br />
=== 框架特性 ===<br />
*摈弃PHP的MySQL扩展，转而使用更高效且面向对象的MySQLi<br />
*Model层被重视，不再是简单的ORM映射，而是真正意义上的数据模型层<br />
*相对严格的命名规范，代码更具可读性<br />
*更安全的访问权限控制<br />
*更强的代码生成工具<br />
<br />
== 快速入门指南 ==<br />
本快歌入门指南假定读者对PHP,MySQL有一定基础。知道MVC或有其他框架开发经验为佳，但是在后面也会有一定介绍。<br />
=== 轻松编程从这里开始 ===<br />
==== [[Protoss/MVC简介|MVC简介]] ====<br />
==== [[Protoss/目录结构|基于Protoss的项目特征和目录结构]] ====<br />
==== [[Protoss/运行|轻松访问到控制器]] ====<br />
<br />
=== Hello world，我的第一个应用软件 ===<br />
==== [[Protoss/控制器|编写控制器]] ====<br />
==== [[Protoss/控制器/动作|控制器中的Action]] ====<br />
==== [[Protoss/控制器/内部方法|我有许多小秘密--private和protected]] ====<br />
<br />
=== 模板引擎 ===<br />
==== [[Protoss/模板/载入模板|很给力！自动引入模板]] ====<br />
==== [[Protoss/模板|视图也可以继承]] ====<br />
==== [[Protoss/模板|看，这些元素其实是可以拆分和复用的]] ====<br />
<br />
=== [[Protoss/模型|了解数据模型]] ===<br />
==== [[Protoss/模型/mysqli|建立MySQLi数据模型]] ====<br />
==== [[Protoss/模型/rest|Rest风格的数据模型]] ====<br />
<br />
== 项目开发权威指南 ==<br />
<br />
=== [[Protoss权威指南/名词解释|名词解释]] ===<br />
<br />
== 附录 ==<br />
=== 附录 A. 代码编写与开发流程规范 ===<br />
==== [[Protoss/规范/概述|概述]] ====<br />
Subversion是一个自由/开源版本控制系统，它管理文件和目录可以超越时间。[[Protoss/规范/概述|更多(利用版本控制进行协助开发)]]<br />
<br />
==== [[Protoss/规范/代码规范|Protoss代码编写规范]] ====<br />
【点此阅读[[Protoss/规范/代码规范|Protoss代码编写规范]]，推荐】<br />
<br />
==== 工作模型 ====<br />
checkout（检出）项目<br />
更新文件或目录 update<br />
修改文件或目录 commit(提交)变更<br />
增加文件或目录 add(增加) <br />
文件或目录 commit(提交)<br />
删除文件或目录 commit(提交)上一级目录<br />
<br />
==== [[Protoss/规范/操作指南|操作指南]] ====<br />
当你在为项目工作时，首先请更新你的工作拷贝来获取那些你上次更新以来其他开发人员对项目做的新改动。[[Protoss/规范/操作指南|更多]]<br />
<br />
==== 开发与测试部署流程 ====<br />
开发人员使用trunk目录进行当前版本开发.在模拟环境中进行单元测试.[[Protoss/规范/测试和部署|更多]]<br />
==== [[Protoss/规范/核心提示|核心提示]] ====<br />
*负责而谨慎地提交自己的代码<br />
*保持原子性的提交<br />
*不要提交自动生成的文件<br />
*不要提交不能通过编译的代码<br />
*不要提交自己不明白的代码<br />
*提前宣布自己的工作计划<br />
*对提交的信息采用明晰的标注<br />
<br />
=== 附录 B. 版权信息 ===<br />
以下版权信息适用于Protoss项目，包括但不限于代码部分。（注：代码仅指Protoss框架代码，不包含开发人员基于此框架的应用程序，各应用程序开发者享有该程序代码的一切权利）<br />
<br />
Copyright &copy; 2009-2010 Snake.Zero<br />
<br />
=== 附录 C. 更新记录 ===<br />
2009年6月 Protoss 0.1beta Protoss诞生<br/><br />
2010年6月 Protoss 0.5beta 经过一年的开发和测试，第一个稳定版本<br/><br />
2020年7月24日 Protoss 0.5.1 Mysqli模型驱动新特性<br/></div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7051
Protoss/规范/代码规范
2010-08-20T04:43:54Z
<p>SnakeZero：/* PHP代码标记 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 基本命名规则 ==<br />
=== 全局变量和函数命名等 ===<br />
* 变量<br />
如果你需要定义一个全局变量的话,应当以美元符号加下划线“$_”开头，后接包名。例如,PEAR包中一个变量就作：$_PEAR_destructor_object_list。<br/><br />
<br/><br />
* 函数的命名<br />
在PEAR的定义中，我们应当使用“驼峰”写法的代码规则，以包名加下划线为前缀。我们以“XML_RPC_serializeData()”来分析。<br/><br />
在命名中缩写词应当全部大写，如上面的XML和RPC，又如Protoss中的“RBAC”(Role-Based Access Control)。如果是几个单词连着写，那么第一个单词应当首字母小写，后面的单词首字母大写，如上面的serializeData。<br/><br />
<br/><br />
* 类中的方法<br />
在类中，public属性的变量或者参数应该以美元符加小写开头变量名来书写，如“$content”，“$mysqlResult”，“$protoss”。<br/><br />
而私有的方法(private)或变量名应该冠以下划线，如“$_mysqlHandle”，“_processMethod()”，“_sort()”，“_intTree()”。<br/><br />
而protected则和public一样，不能加上下划线。<br/><br />
<br/><br />
* 常量<br />
常量的命名应该为全大写，如：DB_DATASOURCENAME 、 SERVICES_AMAZON_S3_LICENSEKEY<br />
<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
所有需要包含在PEAR核心发布的PHP代码文件，在文件开始的时候，你必须加入以下的注释声明：<br />
<source lang="php">/* vim: set expandtab tabstop=4 shiftwidth=4: */<br />
// +----------------------------------------------------------------------+<br />
// | PHP version 4.0 |<br />
// +----------------------------------------------------------------------+<br />
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |<br />
// +----------------------------------------------------------------------+<br />
// | This source file is subject to version 2.0 of the PHP license, |<br />
// | that is bundled with this package in the file LICENSE, and is |<br />
// | available at through the world-wide-web at |<br />
// | http://www.php.net/license/2_02.txt. |<br />
// | If you did not receive a copy of the PHP license and are unable to |<br />
// | obtain it through the world-wide-web, please send a note to |<br />
// | license@php.net so we can mail you a copy immediately. |<br />
// +----------------------------------------------------------------------+<br />
// | Authors: 组织机构名称 |<br />
// | Snake.Zero -- Orochi the Great |<br />
// +----------------------------------------------------------------------+<br />
//<br />
// $Id$<br />
</source><br />
对于不在PEAR核心代码库中的文件，建议你也在文件的开始处有这样一个类似的注释块，标明版权，协议，作者等等。同时也在第一行加入VIM的MODELINE，这样在VIM中能够保持PEAR的代码风格。<br/><br />
* CVS标记：<br />
如上面所展示那样，在每个文件中加入CVS的ID标记，如果你编辑或修改的文件中没有这个标记，那么请加入，或者是替换原文件中相类似的表现形式（如"Last modified"等等）<br />
* URL样本：<br />
你可以参照RFC 2606,使用"www.example.com"作为所有的URL样本。<br />
* 常量命名：<br />
常量应该尽量使用大写，为了便于理解，使用下划线分割每个单词。同时，你应该常量所在的包名或者是类名作为前缀。比如，对于Bug类中常量应该以Bug_开始。以上是PEAR的编码规则，详细的编码规则可以参考PEAR中的CODING_STANDDARD文件的说明。为了更好地理解这些编码规则，你也可以参考一下现有PEAR核心模块的代码。<br />
<br />
== 文件的相关规范 ==<br />
* 所有文件必须是unix文件格式<br />
* 所有文件编码必须是UTF-8<br />
* 文件以ASCII码来存储<br />
<br />
== PHP代码标记 ==<br />
以PEAR的方式来书写时：<br/><br />
任何时候都要使用<?php ?>定义你的php代码，而不要简单地使用<? ?>,这样可以保证PEAR的兼容性，也利于跨平台的移植。<br />
{{notice|content=事实证明，以“<?php”开头更加规范，但是之后的?>确实可以省略。那样可以减少许多无法预期的意外输出。<br/>在PHP中，不使用“?>”结尾不会引起错误，哪怕连NOTICE也没有。}}<br />
<br />
== 全文示例 ==<br />
<source lang="php"><br />
<?php<br />
<br />
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */<br />
<br />
/**<br />
* Short description for file<br />
*<br />
* Long description for file (if any)...<br />
*<br />
* PHP version 5<br />
*<br />
* LICENSE: This source file is subject to version 3.01 of the PHP license<br />
* that is available through the world-wide-web at the following URI:<br />
* http://www.php.net/license/3_01.txt. If you did not receive a copy of<br />
* the PHP License and are unable to obtain it through the web, please<br />
* send a note to license@php.net so we can mail you a copy immediately.<br />
*<br />
* @category CategoryName<br />
* @package PackageName<br />
* @author Original Author <author@example.com><br />
* @author Another Author <another@example.com><br />
* @copyright 1997-2005 The PHP Group<br />
* @license http://www.php.net/license/3_01.txt PHP License 3.01<br />
* @version CVS: <?php<br />
$<br />
?> Id:$<br />
* @link http://pear.php.net/package/PackageName<br />
* @see NetOther, Net_Sample::Net_Sample()<br />
* @since File available since Release 1.2.0<br />
* @deprecated File deprecated in Release 2.0.0<br />
*/<br />
<br />
/**<br />
* This is a "Docblock Comment," also known as a "docblock." The class'<br />
* docblock, below, contains a complete description of how to write these.<br />
*/<br />
require_once 'PEAR.php';<br />
<br />
// {{{ constants<br />
<br />
/**<br />
* Methods return this if they succeed<br />
*/<br />
define('NET_SAMPLE_OK', 1);<br />
<br />
// }}}<br />
// {{{ GLOBALS<br />
<br />
/**<br />
* The number of objects created<br />
* @global int $GLOBALS['_NET_SAMPLE_Count']<br />
*/<br />
$GLOBALS['_NET_SAMPLE_Count'] = 0;<br />
<br />
// }}}<br />
// {{{ Net_Sample<br />
<br />
/**<br />
* An example of how to write code to PEAR's standards<br />
*<br />
* Docblock comments start with "/**" at the top. Notice how the "/"<br />
* lines up with the normal indenting and the asterisks on subsequent rows<br />
* are in line with the first asterisk. The last line of comment text<br />
* should be immediately followed on the next line by the closing asterisk<br />
* and slash and then the item you are commenting on should be on the next<br />
* line below that. Don't add extra lines. Please put a blank line<br />
* between paragraphs as well as between the end of the description and<br />
* the start of the @tags. Wrap comments before 80 columns in order to<br />
* ease readability for a wide variety of users.<br />
*<br />
* Docblocks can only be used for programming constructs which allow them<br />
* (classes, properties, methods, defines, includes, globals). See the<br />
* phpDocumentor documentation for more information.<br />
* http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html<br />
*<br />
* The Javadoc Style Guide is an excellent resource for figuring out<br />
* how to say what needs to be said in docblock comments. Much of what is<br />
* written here is a summary of what is found there, though there are some<br />
* cases where what's said here overrides what is said there.<br />
* http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#styleguide<br />
*<br />
* The first line of any docblock is the summary. Make them one short<br />
* sentence, without a period at the end. Summaries for classes, properties<br />
* and constants should omit the subject and simply state the object,<br />
* because they are describing things rather than actions or behaviors.<br />
*<br />
* Below are the tags commonly used for classes. @category through @version<br />
* are required. The remainder should only be used when necessary.<br />
* Please use them in the order they appear here. phpDocumentor has<br />
* several other tags available, feel free to use them.<br />
*<br />
* @category CategoryName<br />
* @package PackageName<br />
* @author Original Author <author@example.com><br />
* @author Another Author <another@example.com><br />
* @copyright 1997-2005 The PHP Group<br />
* @license http://www.php.net/license/3_01.txt PHP License 3.01<br />
* @version Release: @package_version@<br />
* @link http://pear.php.net/package/PackageName<br />
* @see NetOther, Net_Sample::Net_Sample()<br />
* @since Class available since Release 1.2.0<br />
* @deprecated Class deprecated in Release 2.0.0<br />
*/<br />
class Net_Sample<br />
{<br />
// {{{ properties<br />
<br />
/**<br />
* The status of foo's universe<br />
*<br />
* Potential values are 'good', 'fair', 'poor' and 'unknown'.<br />
*<br />
* @var string<br />
*/<br />
var $foo = 'unknown';<br />
<br />
/**<br />
* The status of life<br />
*<br />
* Note that names of private properties or methods must be<br />
* preceeded by an underscore.<br />
*<br />
* @var bool<br />
* @access private<br />
*/<br />
var $_good = true;<br />
<br />
// }}}<br />
// {{{ setFoo()<br />
<br />
/**<br />
* Registers the status of foo's universe<br />
*<br />
* Summaries for methods should use 3rd person declarative rather<br />
* than 2nd person imperative, beginning with a verb phrase.<br />
*<br />
* Summaries should add description beyond the method's name. The<br />
* best method names are "self-documenting", meaning they tell you<br />
* basically what the method does. If the summary merely repeats<br />
* the method name in sentence form, it is not providing more<br />
* information.<br />
*<br />
* Summary Examples:<br />
* + Sets the label (preferred)<br />
* + Set the label (avoid)<br />
* + This method sets the label (avoid)<br />
*<br />
* Below are the tags commonly used for methods. A @param tag is<br />
* required for each parameter the method has. The @return<br />
* and @access tags are mandatory. The @throws tag is required if<br />
* the method uses exceptions. @static is required if the method can<br />
* be called statically. The remainder should only be used when<br />
* necessary. Please use them in the order they appear here.<br />
* phpDocumentor has several other tags available, feel free to use<br />
* them.<br />
*<br />
* The @param tag contains the data type, then the parameter's<br />
* name, followed by a description. By convention, the first noun in<br />
* the description is the data type of the parameter. Articles like<br />
* "a", "an", and "the" can precede the noun. The descriptions<br />
* should start with a phrase. If further description is necessary,<br />
* follow with sentences. Having two spaces between the name and the<br />
* description aids readability.<br />
*<br />
* When writing a phrase, do not capitalize and do not end with a<br />
* period:<br />
* + the string to be tested<br />
*<br />
* When writing a phrase followed by a sentence, do not capitalize the<br />
* phrase, but end it with a period to distinguish it from the start<br />
* of the next sentence:<br />
* + the string to be tested. Must use UTF-8 encoding.<br />
*<br />
* Return tags should contain the data type then a description of<br />
* the data returned. The data type can be any of PHP's data types<br />
* (int, float, bool, string, array, object, resource, mixed)<br />
* and should contain the type primarily returned. For example, if<br />
* a method returns an object when things work correctly but false<br />
* when an error happens, say 'object' rather than 'mixed.' Use<br />
* 'void' if nothing is returned.<br />
*<br />
* Here's an example of how to format examples:<br />
* <code><br />
* require_once 'Net/Sample.php';<br />
*<br />
* $s = new Net_Sample();<br />
* if (PEAR::isError($s)) {<br />
* echo $s->getMessage() . "\n";<br />
* }<br />
* </code><br />
*<br />
* Here is an example for non-php example or sample:<br />
* <samp><br />
* pear install net_sample<br />
* </samp><br />
*<br />
* @param string $arg1 the string to quote<br />
* @param int $arg2 an integer of how many problems happened.<br />
* Indent to the description's starting point<br />
* for long ones.<br />
*<br />
* @return int the integer of the set mode used. FALSE if foo<br />
* foo could not be set.<br />
* @throws exceptionclass [description]<br />
*<br />
* @access public<br />
* @static<br />
* @see Net_Sample::$foo, Net_Other::someMethod()<br />
* @since Method available since Release 1.2.0<br />
* @deprecated Method deprecated in Release 2.0.0<br />
*/<br />
function setFoo($arg1, $arg2 = 0)<br />
{<br />
/*<br />
* This is a "Block Comment." The format is the same as<br />
* Docblock Comments except there is only one asterisk at the<br />
* top. phpDocumentor doesn't parse these.<br />
*/<br />
if ($arg1 == 'good' || $arg1 == 'fair') {<br />
$this->foo = $arg1;<br />
return 1;<br />
} elseif ($arg1 == 'poor' && $arg2 > 1) {<br />
$this->foo = 'poor';<br />
return 2;<br />
} else {<br />
return false;<br />
}<br />
}<br />
<br />
// }}}<br />
}<br />
<br />
// }}}<br />
<br />
/*<br />
* Local variables:<br />
* tab-width: 4<br />
* c-basic-offset: 4<br />
* c-hanging-comment-ender-p: nil<br />
* End:<br />
*/<br />
<br />
?></source></div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7050
Protoss/规范/代码规范
2010-08-20T04:43:13Z
<p>SnakeZero：/* 文件的相关规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 基本命名规则 ==<br />
=== 全局变量和函数命名等 ===<br />
* 变量<br />
如果你需要定义一个全局变量的话,应当以美元符号加下划线“$_”开头，后接包名。例如,PEAR包中一个变量就作：$_PEAR_destructor_object_list。<br/><br />
<br/><br />
* 函数的命名<br />
在PEAR的定义中，我们应当使用“驼峰”写法的代码规则，以包名加下划线为前缀。我们以“XML_RPC_serializeData()”来分析。<br/><br />
在命名中缩写词应当全部大写，如上面的XML和RPC，又如Protoss中的“RBAC”(Role-Based Access Control)。如果是几个单词连着写，那么第一个单词应当首字母小写，后面的单词首字母大写，如上面的serializeData。<br/><br />
<br/><br />
* 类中的方法<br />
在类中，public属性的变量或者参数应该以美元符加小写开头变量名来书写，如“$content”，“$mysqlResult”，“$protoss”。<br/><br />
而私有的方法(private)或变量名应该冠以下划线，如“$_mysqlHandle”，“_processMethod()”，“_sort()”，“_intTree()”。<br/><br />
而protected则和public一样，不能加上下划线。<br/><br />
<br/><br />
* 常量<br />
常量的命名应该为全大写，如：DB_DATASOURCENAME 、 SERVICES_AMAZON_S3_LICENSEKEY<br />
<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
所有需要包含在PEAR核心发布的PHP代码文件，在文件开始的时候，你必须加入以下的注释声明：<br />
<source lang="php">/* vim: set expandtab tabstop=4 shiftwidth=4: */<br />
// +----------------------------------------------------------------------+<br />
// | PHP version 4.0 |<br />
// +----------------------------------------------------------------------+<br />
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |<br />
// +----------------------------------------------------------------------+<br />
// | This source file is subject to version 2.0 of the PHP license, |<br />
// | that is bundled with this package in the file LICENSE, and is |<br />
// | available at through the world-wide-web at |<br />
// | http://www.php.net/license/2_02.txt. |<br />
// | If you did not receive a copy of the PHP license and are unable to |<br />
// | obtain it through the world-wide-web, please send a note to |<br />
// | license@php.net so we can mail you a copy immediately. |<br />
// +----------------------------------------------------------------------+<br />
// | Authors: 组织机构名称 |<br />
// | Snake.Zero -- Orochi the Great |<br />
// +----------------------------------------------------------------------+<br />
//<br />
// $Id$<br />
</source><br />
对于不在PEAR核心代码库中的文件，建议你也在文件的开始处有这样一个类似的注释块，标明版权，协议，作者等等。同时也在第一行加入VIM的MODELINE，这样在VIM中能够保持PEAR的代码风格。<br/><br />
* CVS标记：<br />
如上面所展示那样，在每个文件中加入CVS的ID标记，如果你编辑或修改的文件中没有这个标记，那么请加入，或者是替换原文件中相类似的表现形式（如"Last modified"等等）<br />
* URL样本：<br />
你可以参照RFC 2606,使用"www.example.com"作为所有的URL样本。<br />
* 常量命名：<br />
常量应该尽量使用大写，为了便于理解，使用下划线分割每个单词。同时，你应该常量所在的包名或者是类名作为前缀。比如，对于Bug类中常量应该以Bug_开始。以上是PEAR的编码规则，详细的编码规则可以参考PEAR中的CODING_STANDDARD文件的说明。为了更好地理解这些编码规则，你也可以参考一下现有PEAR核心模块的代码。<br />
<br />
== 文件的相关规范 ==<br />
* 所有文件必须是unix文件格式<br />
* 所有文件编码必须是UTF-8<br />
* 文件以ASCII码来存储<br />
<br />
== PHP代码标记 ==<br />
以PEAR的方式来书写时：<br/><br />
任何时候都要使用<?php ?>定义你的php代码，而不要简单地使用<? ?>,这样可以保证PEAR的兼容性，也利于跨平台的移植。<br />
{{noteice|content=事实证明，以<?php开头更加规范，但是之后的?>确实可以省略。那样可以减少许多无法预期的意外输出。<br/>在PHP中，不使用“?>”结尾不会引起错误，哪怕连NOTICE也没有。}}<br />
<br />
== 全文示例 ==<br />
<source lang="php"><br />
<?php<br />
<br />
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */<br />
<br />
/**<br />
* Short description for file<br />
*<br />
* Long description for file (if any)...<br />
*<br />
* PHP version 5<br />
*<br />
* LICENSE: This source file is subject to version 3.01 of the PHP license<br />
* that is available through the world-wide-web at the following URI:<br />
* http://www.php.net/license/3_01.txt. If you did not receive a copy of<br />
* the PHP License and are unable to obtain it through the web, please<br />
* send a note to license@php.net so we can mail you a copy immediately.<br />
*<br />
* @category CategoryName<br />
* @package PackageName<br />
* @author Original Author <author@example.com><br />
* @author Another Author <another@example.com><br />
* @copyright 1997-2005 The PHP Group<br />
* @license http://www.php.net/license/3_01.txt PHP License 3.01<br />
* @version CVS: <?php<br />
$<br />
?> Id:$<br />
* @link http://pear.php.net/package/PackageName<br />
* @see NetOther, Net_Sample::Net_Sample()<br />
* @since File available since Release 1.2.0<br />
* @deprecated File deprecated in Release 2.0.0<br />
*/<br />
<br />
/**<br />
* This is a "Docblock Comment," also known as a "docblock." The class'<br />
* docblock, below, contains a complete description of how to write these.<br />
*/<br />
require_once 'PEAR.php';<br />
<br />
// {{{ constants<br />
<br />
/**<br />
* Methods return this if they succeed<br />
*/<br />
define('NET_SAMPLE_OK', 1);<br />
<br />
// }}}<br />
// {{{ GLOBALS<br />
<br />
/**<br />
* The number of objects created<br />
* @global int $GLOBALS['_NET_SAMPLE_Count']<br />
*/<br />
$GLOBALS['_NET_SAMPLE_Count'] = 0;<br />
<br />
// }}}<br />
// {{{ Net_Sample<br />
<br />
/**<br />
* An example of how to write code to PEAR's standards<br />
*<br />
* Docblock comments start with "/**" at the top. Notice how the "/"<br />
* lines up with the normal indenting and the asterisks on subsequent rows<br />
* are in line with the first asterisk. The last line of comment text<br />
* should be immediately followed on the next line by the closing asterisk<br />
* and slash and then the item you are commenting on should be on the next<br />
* line below that. Don't add extra lines. Please put a blank line<br />
* between paragraphs as well as between the end of the description and<br />
* the start of the @tags. Wrap comments before 80 columns in order to<br />
* ease readability for a wide variety of users.<br />
*<br />
* Docblocks can only be used for programming constructs which allow them<br />
* (classes, properties, methods, defines, includes, globals). See the<br />
* phpDocumentor documentation for more information.<br />
* http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html<br />
*<br />
* The Javadoc Style Guide is an excellent resource for figuring out<br />
* how to say what needs to be said in docblock comments. Much of what is<br />
* written here is a summary of what is found there, though there are some<br />
* cases where what's said here overrides what is said there.<br />
* http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#styleguide<br />
*<br />
* The first line of any docblock is the summary. Make them one short<br />
* sentence, without a period at the end. Summaries for classes, properties<br />
* and constants should omit the subject and simply state the object,<br />
* because they are describing things rather than actions or behaviors.<br />
*<br />
* Below are the tags commonly used for classes. @category through @version<br />
* are required. The remainder should only be used when necessary.<br />
* Please use them in the order they appear here. phpDocumentor has<br />
* several other tags available, feel free to use them.<br />
*<br />
* @category CategoryName<br />
* @package PackageName<br />
* @author Original Author <author@example.com><br />
* @author Another Author <another@example.com><br />
* @copyright 1997-2005 The PHP Group<br />
* @license http://www.php.net/license/3_01.txt PHP License 3.01<br />
* @version Release: @package_version@<br />
* @link http://pear.php.net/package/PackageName<br />
* @see NetOther, Net_Sample::Net_Sample()<br />
* @since Class available since Release 1.2.0<br />
* @deprecated Class deprecated in Release 2.0.0<br />
*/<br />
class Net_Sample<br />
{<br />
// {{{ properties<br />
<br />
/**<br />
* The status of foo's universe<br />
*<br />
* Potential values are 'good', 'fair', 'poor' and 'unknown'.<br />
*<br />
* @var string<br />
*/<br />
var $foo = 'unknown';<br />
<br />
/**<br />
* The status of life<br />
*<br />
* Note that names of private properties or methods must be<br />
* preceeded by an underscore.<br />
*<br />
* @var bool<br />
* @access private<br />
*/<br />
var $_good = true;<br />
<br />
// }}}<br />
// {{{ setFoo()<br />
<br />
/**<br />
* Registers the status of foo's universe<br />
*<br />
* Summaries for methods should use 3rd person declarative rather<br />
* than 2nd person imperative, beginning with a verb phrase.<br />
*<br />
* Summaries should add description beyond the method's name. The<br />
* best method names are "self-documenting", meaning they tell you<br />
* basically what the method does. If the summary merely repeats<br />
* the method name in sentence form, it is not providing more<br />
* information.<br />
*<br />
* Summary Examples:<br />
* + Sets the label (preferred)<br />
* + Set the label (avoid)<br />
* + This method sets the label (avoid)<br />
*<br />
* Below are the tags commonly used for methods. A @param tag is<br />
* required for each parameter the method has. The @return<br />
* and @access tags are mandatory. The @throws tag is required if<br />
* the method uses exceptions. @static is required if the method can<br />
* be called statically. The remainder should only be used when<br />
* necessary. Please use them in the order they appear here.<br />
* phpDocumentor has several other tags available, feel free to use<br />
* them.<br />
*<br />
* The @param tag contains the data type, then the parameter's<br />
* name, followed by a description. By convention, the first noun in<br />
* the description is the data type of the parameter. Articles like<br />
* "a", "an", and "the" can precede the noun. The descriptions<br />
* should start with a phrase. If further description is necessary,<br />
* follow with sentences. Having two spaces between the name and the<br />
* description aids readability.<br />
*<br />
* When writing a phrase, do not capitalize and do not end with a<br />
* period:<br />
* + the string to be tested<br />
*<br />
* When writing a phrase followed by a sentence, do not capitalize the<br />
* phrase, but end it with a period to distinguish it from the start<br />
* of the next sentence:<br />
* + the string to be tested. Must use UTF-8 encoding.<br />
*<br />
* Return tags should contain the data type then a description of<br />
* the data returned. The data type can be any of PHP's data types<br />
* (int, float, bool, string, array, object, resource, mixed)<br />
* and should contain the type primarily returned. For example, if<br />
* a method returns an object when things work correctly but false<br />
* when an error happens, say 'object' rather than 'mixed.' Use<br />
* 'void' if nothing is returned.<br />
*<br />
* Here's an example of how to format examples:<br />
* <code><br />
* require_once 'Net/Sample.php';<br />
*<br />
* $s = new Net_Sample();<br />
* if (PEAR::isError($s)) {<br />
* echo $s->getMessage() . "\n";<br />
* }<br />
* </code><br />
*<br />
* Here is an example for non-php example or sample:<br />
* <samp><br />
* pear install net_sample<br />
* </samp><br />
*<br />
* @param string $arg1 the string to quote<br />
* @param int $arg2 an integer of how many problems happened.<br />
* Indent to the description's starting point<br />
* for long ones.<br />
*<br />
* @return int the integer of the set mode used. FALSE if foo<br />
* foo could not be set.<br />
* @throws exceptionclass [description]<br />
*<br />
* @access public<br />
* @static<br />
* @see Net_Sample::$foo, Net_Other::someMethod()<br />
* @since Method available since Release 1.2.0<br />
* @deprecated Method deprecated in Release 2.0.0<br />
*/<br />
function setFoo($arg1, $arg2 = 0)<br />
{<br />
/*<br />
* This is a "Block Comment." The format is the same as<br />
* Docblock Comments except there is only one asterisk at the<br />
* top. phpDocumentor doesn't parse these.<br />
*/<br />
if ($arg1 == 'good' || $arg1 == 'fair') {<br />
$this->foo = $arg1;<br />
return 1;<br />
} elseif ($arg1 == 'poor' && $arg2 > 1) {<br />
$this->foo = 'poor';<br />
return 2;<br />
} else {<br />
return false;<br />
}<br />
}<br />
<br />
// }}}<br />
}<br />
<br />
// }}}<br />
<br />
/*<br />
* Local variables:<br />
* tab-width: 4<br />
* c-basic-offset: 4<br />
* c-hanging-comment-ender-p: nil<br />
* End:<br />
*/<br />
<br />
?></source></div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7049
Protoss/规范/代码规范
2010-08-20T04:39:06Z
<p>SnakeZero：/* 全局变量和函数命名等 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 基本命名规则 ==<br />
=== 全局变量和函数命名等 ===<br />
* 变量<br />
如果你需要定义一个全局变量的话,应当以美元符号加下划线“$_”开头，后接包名。例如,PEAR包中一个变量就作：$_PEAR_destructor_object_list。<br/><br />
<br/><br />
* 函数的命名<br />
在PEAR的定义中，我们应当使用“驼峰”写法的代码规则，以包名加下划线为前缀。我们以“XML_RPC_serializeData()”来分析。<br/><br />
在命名中缩写词应当全部大写，如上面的XML和RPC，又如Protoss中的“RBAC”(Role-Based Access Control)。如果是几个单词连着写，那么第一个单词应当首字母小写，后面的单词首字母大写，如上面的serializeData。<br/><br />
<br/><br />
* 类中的方法<br />
在类中，public属性的变量或者参数应该以美元符加小写开头变量名来书写，如“$content”，“$mysqlResult”，“$protoss”。<br/><br />
而私有的方法(private)或变量名应该冠以下划线，如“$_mysqlHandle”，“_processMethod()”，“_sort()”，“_intTree()”。<br/><br />
而protected则和public一样，不能加上下划线。<br/><br />
<br/><br />
* 常量<br />
常量的命名应该为全大写，如：DB_DATASOURCENAME 、 SERVICES_AMAZON_S3_LICENSEKEY<br />
<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
所有需要包含在PEAR核心发布的PHP代码文件，在文件开始的时候，你必须加入以下的注释声明：<br />
<source lang="php">/* vim: set expandtab tabstop=4 shiftwidth=4: */<br />
// +----------------------------------------------------------------------+<br />
// | PHP version 4.0 |<br />
// +----------------------------------------------------------------------+<br />
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |<br />
// +----------------------------------------------------------------------+<br />
// | This source file is subject to version 2.0 of the PHP license, |<br />
// | that is bundled with this package in the file LICENSE, and is |<br />
// | available at through the world-wide-web at |<br />
// | http://www.php.net/license/2_02.txt. |<br />
// | If you did not receive a copy of the PHP license and are unable to |<br />
// | obtain it through the world-wide-web, please send a note to |<br />
// | license@php.net so we can mail you a copy immediately. |<br />
// +----------------------------------------------------------------------+<br />
// | Authors: 组织机构名称 |<br />
// | Snake.Zero -- Orochi the Great |<br />
// +----------------------------------------------------------------------+<br />
//<br />
// $Id$<br />
</source><br />
对于不在PEAR核心代码库中的文件，建议你也在文件的开始处有这样一个类似的注释块，标明版权，协议，作者等等。同时也在第一行加入VIM的MODELINE，这样在VIM中能够保持PEAR的代码风格。<br/><br />
* CVS标记：<br />
如上面所展示那样，在每个文件中加入CVS的ID标记，如果你编辑或修改的文件中没有这个标记，那么请加入，或者是替换原文件中相类似的表现形式（如"Last modified"等等）<br />
* URL样本：<br />
你可以参照RFC 2606,使用"www.example.com"作为所有的URL样本。<br />
* 常量命名：<br />
常量应该尽量使用大写，为了便于理解，使用下划线分割每个单词。同时，你应该常量所在的包名或者是类名作为前缀。比如，对于Bug类中常量应该以Bug_开始。以上是PEAR的编码规则，详细的编码规则可以参考PEAR中的CODING_STANDDARD文件的说明。为了更好地理解这些编码规则，你也可以参考一下现有PEAR核心模块的代码。<br />
<br />
== 文件的相关规范 ==<br />
* 所有文件必须是unix文件格式<br />
* 所有文件编码必须是UTF-8<br />
* 文件以ASCII码来存储<br />
<br />
== 全文示例 ==<br />
<source lang="php"><br />
<?php<br />
<br />
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */<br />
<br />
/**<br />
* Short description for file<br />
*<br />
* Long description for file (if any)...<br />
*<br />
* PHP version 5<br />
*<br />
* LICENSE: This source file is subject to version 3.01 of the PHP license<br />
* that is available through the world-wide-web at the following URI:<br />
* http://www.php.net/license/3_01.txt. If you did not receive a copy of<br />
* the PHP License and are unable to obtain it through the web, please<br />
* send a note to license@php.net so we can mail you a copy immediately.<br />
*<br />
* @category CategoryName<br />
* @package PackageName<br />
* @author Original Author <author@example.com><br />
* @author Another Author <another@example.com><br />
* @copyright 1997-2005 The PHP Group<br />
* @license http://www.php.net/license/3_01.txt PHP License 3.01<br />
* @version CVS: <?php<br />
$<br />
?> Id:$<br />
* @link http://pear.php.net/package/PackageName<br />
* @see NetOther, Net_Sample::Net_Sample()<br />
* @since File available since Release 1.2.0<br />
* @deprecated File deprecated in Release 2.0.0<br />
*/<br />
<br />
/**<br />
* This is a "Docblock Comment," also known as a "docblock." The class'<br />
* docblock, below, contains a complete description of how to write these.<br />
*/<br />
require_once 'PEAR.php';<br />
<br />
// {{{ constants<br />
<br />
/**<br />
* Methods return this if they succeed<br />
*/<br />
define('NET_SAMPLE_OK', 1);<br />
<br />
// }}}<br />
// {{{ GLOBALS<br />
<br />
/**<br />
* The number of objects created<br />
* @global int $GLOBALS['_NET_SAMPLE_Count']<br />
*/<br />
$GLOBALS['_NET_SAMPLE_Count'] = 0;<br />
<br />
// }}}<br />
// {{{ Net_Sample<br />
<br />
/**<br />
* An example of how to write code to PEAR's standards<br />
*<br />
* Docblock comments start with "/**" at the top. Notice how the "/"<br />
* lines up with the normal indenting and the asterisks on subsequent rows<br />
* are in line with the first asterisk. The last line of comment text<br />
* should be immediately followed on the next line by the closing asterisk<br />
* and slash and then the item you are commenting on should be on the next<br />
* line below that. Don't add extra lines. Please put a blank line<br />
* between paragraphs as well as between the end of the description and<br />
* the start of the @tags. Wrap comments before 80 columns in order to<br />
* ease readability for a wide variety of users.<br />
*<br />
* Docblocks can only be used for programming constructs which allow them<br />
* (classes, properties, methods, defines, includes, globals). See the<br />
* phpDocumentor documentation for more information.<br />
* http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html<br />
*<br />
* The Javadoc Style Guide is an excellent resource for figuring out<br />
* how to say what needs to be said in docblock comments. Much of what is<br />
* written here is a summary of what is found there, though there are some<br />
* cases where what's said here overrides what is said there.<br />
* http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#styleguide<br />
*<br />
* The first line of any docblock is the summary. Make them one short<br />
* sentence, without a period at the end. Summaries for classes, properties<br />
* and constants should omit the subject and simply state the object,<br />
* because they are describing things rather than actions or behaviors.<br />
*<br />
* Below are the tags commonly used for classes. @category through @version<br />
* are required. The remainder should only be used when necessary.<br />
* Please use them in the order they appear here. phpDocumentor has<br />
* several other tags available, feel free to use them.<br />
*<br />
* @category CategoryName<br />
* @package PackageName<br />
* @author Original Author <author@example.com><br />
* @author Another Author <another@example.com><br />
* @copyright 1997-2005 The PHP Group<br />
* @license http://www.php.net/license/3_01.txt PHP License 3.01<br />
* @version Release: @package_version@<br />
* @link http://pear.php.net/package/PackageName<br />
* @see NetOther, Net_Sample::Net_Sample()<br />
* @since Class available since Release 1.2.0<br />
* @deprecated Class deprecated in Release 2.0.0<br />
*/<br />
class Net_Sample<br />
{<br />
// {{{ properties<br />
<br />
/**<br />
* The status of foo's universe<br />
*<br />
* Potential values are 'good', 'fair', 'poor' and 'unknown'.<br />
*<br />
* @var string<br />
*/<br />
var $foo = 'unknown';<br />
<br />
/**<br />
* The status of life<br />
*<br />
* Note that names of private properties or methods must be<br />
* preceeded by an underscore.<br />
*<br />
* @var bool<br />
* @access private<br />
*/<br />
var $_good = true;<br />
<br />
// }}}<br />
// {{{ setFoo()<br />
<br />
/**<br />
* Registers the status of foo's universe<br />
*<br />
* Summaries for methods should use 3rd person declarative rather<br />
* than 2nd person imperative, beginning with a verb phrase.<br />
*<br />
* Summaries should add description beyond the method's name. The<br />
* best method names are "self-documenting", meaning they tell you<br />
* basically what the method does. If the summary merely repeats<br />
* the method name in sentence form, it is not providing more<br />
* information.<br />
*<br />
* Summary Examples:<br />
* + Sets the label (preferred)<br />
* + Set the label (avoid)<br />
* + This method sets the label (avoid)<br />
*<br />
* Below are the tags commonly used for methods. A @param tag is<br />
* required for each parameter the method has. The @return<br />
* and @access tags are mandatory. The @throws tag is required if<br />
* the method uses exceptions. @static is required if the method can<br />
* be called statically. The remainder should only be used when<br />
* necessary. Please use them in the order they appear here.<br />
* phpDocumentor has several other tags available, feel free to use<br />
* them.<br />
*<br />
* The @param tag contains the data type, then the parameter's<br />
* name, followed by a description. By convention, the first noun in<br />
* the description is the data type of the parameter. Articles like<br />
* "a", "an", and "the" can precede the noun. The descriptions<br />
* should start with a phrase. If further description is necessary,<br />
* follow with sentences. Having two spaces between the name and the<br />
* description aids readability.<br />
*<br />
* When writing a phrase, do not capitalize and do not end with a<br />
* period:<br />
* + the string to be tested<br />
*<br />
* When writing a phrase followed by a sentence, do not capitalize the<br />
* phrase, but end it with a period to distinguish it from the start<br />
* of the next sentence:<br />
* + the string to be tested. Must use UTF-8 encoding.<br />
*<br />
* Return tags should contain the data type then a description of<br />
* the data returned. The data type can be any of PHP's data types<br />
* (int, float, bool, string, array, object, resource, mixed)<br />
* and should contain the type primarily returned. For example, if<br />
* a method returns an object when things work correctly but false<br />
* when an error happens, say 'object' rather than 'mixed.' Use<br />
* 'void' if nothing is returned.<br />
*<br />
* Here's an example of how to format examples:<br />
* <code><br />
* require_once 'Net/Sample.php';<br />
*<br />
* $s = new Net_Sample();<br />
* if (PEAR::isError($s)) {<br />
* echo $s->getMessage() . "\n";<br />
* }<br />
* </code><br />
*<br />
* Here is an example for non-php example or sample:<br />
* <samp><br />
* pear install net_sample<br />
* </samp><br />
*<br />
* @param string $arg1 the string to quote<br />
* @param int $arg2 an integer of how many problems happened.<br />
* Indent to the description's starting point<br />
* for long ones.<br />
*<br />
* @return int the integer of the set mode used. FALSE if foo<br />
* foo could not be set.<br />
* @throws exceptionclass [description]<br />
*<br />
* @access public<br />
* @static<br />
* @see Net_Sample::$foo, Net_Other::someMethod()<br />
* @since Method available since Release 1.2.0<br />
* @deprecated Method deprecated in Release 2.0.0<br />
*/<br />
function setFoo($arg1, $arg2 = 0)<br />
{<br />
/*<br />
* This is a "Block Comment." The format is the same as<br />
* Docblock Comments except there is only one asterisk at the<br />
* top. phpDocumentor doesn't parse these.<br />
*/<br />
if ($arg1 == 'good' || $arg1 == 'fair') {<br />
$this->foo = $arg1;<br />
return 1;<br />
} elseif ($arg1 == 'poor' && $arg2 > 1) {<br />
$this->foo = 'poor';<br />
return 2;<br />
} else {<br />
return false;<br />
}<br />
}<br />
<br />
// }}}<br />
}<br />
<br />
// }}}<br />
<br />
/*<br />
* Local variables:<br />
* tab-width: 4<br />
* c-basic-offset: 4<br />
* c-hanging-comment-ender-p: nil<br />
* End:<br />
*/<br />
<br />
?></source></div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7048
Protoss/规范/代码规范
2010-08-20T04:38:16Z
<p>SnakeZero：/* 全局变量和函数命名 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 基本命名规则 ==<br />
=== 全局变量和函数命名等 ===<br />
* 变量<br />
如果你需要定义一个全局变量的话,应当以美元符号加下划线“$_”开头，后接包名。例如,PEAR包中一个变量就作：$_PEAR_destructor_object_list。<br/><br />
<br/><br />
* 函数的命名<br />
在PEAR的定义中，我们应当使用“驼峰”写法的代码规则，以包名加下划线为前缀。我们以“XML_RPC_serializeData()”来分析。<br/><br />
在命名中缩写词应当全部大写，如上面的XML和RPC，又如Protoss中的“RBAC”(Role-Based Access Control)。如果是几个单词连着写，那么第一个单词应当首字母小写，后面的单词首字母大写，如上面的serializeData。<br/><br />
<br/><br />
* 类中的方法<br />
在类中，public属性的变量或者参数应该以美元符加小写开头变量名来书写，如“$content”，“$mysqlResult”，“$protoss”。<br/><br />
而私有的方法(private)或变量名应该冠以下划线，如“$_mysqlHandle”，“_processMethod()”，“_sort()”，“_intTree()”。<br/><br />
而protected则和public一样，不能加上下划线。<br/><br />
<br/><br />
*<br />
<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
所有需要包含在PEAR核心发布的PHP代码文件，在文件开始的时候，你必须加入以下的注释声明：<br />
<source lang="php">/* vim: set expandtab tabstop=4 shiftwidth=4: */<br />
// +----------------------------------------------------------------------+<br />
// | PHP version 4.0 |<br />
// +----------------------------------------------------------------------+<br />
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |<br />
// +----------------------------------------------------------------------+<br />
// | This source file is subject to version 2.0 of the PHP license, |<br />
// | that is bundled with this package in the file LICENSE, and is |<br />
// | available at through the world-wide-web at |<br />
// | http://www.php.net/license/2_02.txt. |<br />
// | If you did not receive a copy of the PHP license and are unable to |<br />
// | obtain it through the world-wide-web, please send a note to |<br />
// | license@php.net so we can mail you a copy immediately. |<br />
// +----------------------------------------------------------------------+<br />
// | Authors: 组织机构名称 |<br />
// | Snake.Zero -- Orochi the Great |<br />
// +----------------------------------------------------------------------+<br />
//<br />
// $Id$<br />
</source><br />
对于不在PEAR核心代码库中的文件，建议你也在文件的开始处有这样一个类似的注释块，标明版权，协议，作者等等。同时也在第一行加入VIM的MODELINE，这样在VIM中能够保持PEAR的代码风格。<br/><br />
* CVS标记：<br />
如上面所展示那样，在每个文件中加入CVS的ID标记，如果你编辑或修改的文件中没有这个标记，那么请加入，或者是替换原文件中相类似的表现形式（如"Last modified"等等）<br />
* URL样本：<br />
你可以参照RFC 2606,使用"www.example.com"作为所有的URL样本。<br />
* 常量命名：<br />
常量应该尽量使用大写，为了便于理解，使用下划线分割每个单词。同时，你应该常量所在的包名或者是类名作为前缀。比如，对于Bug类中常量应该以Bug_开始。以上是PEAR的编码规则，详细的编码规则可以参考PEAR中的CODING_STANDDARD文件的说明。为了更好地理解这些编码规则，你也可以参考一下现有PEAR核心模块的代码。<br />
<br />
== 文件的相关规范 ==<br />
* 所有文件必须是unix文件格式<br />
* 所有文件编码必须是UTF-8<br />
* 文件以ASCII码来存储<br />
<br />
== 全文示例 ==<br />
<source lang="php"><br />
<?php<br />
<br />
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */<br />
<br />
/**<br />
* Short description for file<br />
*<br />
* Long description for file (if any)...<br />
*<br />
* PHP version 5<br />
*<br />
* LICENSE: This source file is subject to version 3.01 of the PHP license<br />
* that is available through the world-wide-web at the following URI:<br />
* http://www.php.net/license/3_01.txt. If you did not receive a copy of<br />
* the PHP License and are unable to obtain it through the web, please<br />
* send a note to license@php.net so we can mail you a copy immediately.<br />
*<br />
* @category CategoryName<br />
* @package PackageName<br />
* @author Original Author <author@example.com><br />
* @author Another Author <another@example.com><br />
* @copyright 1997-2005 The PHP Group<br />
* @license http://www.php.net/license/3_01.txt PHP License 3.01<br />
* @version CVS: <?php<br />
$<br />
?> Id:$<br />
* @link http://pear.php.net/package/PackageName<br />
* @see NetOther, Net_Sample::Net_Sample()<br />
* @since File available since Release 1.2.0<br />
* @deprecated File deprecated in Release 2.0.0<br />
*/<br />
<br />
/**<br />
* This is a "Docblock Comment," also known as a "docblock." The class'<br />
* docblock, below, contains a complete description of how to write these.<br />
*/<br />
require_once 'PEAR.php';<br />
<br />
// {{{ constants<br />
<br />
/**<br />
* Methods return this if they succeed<br />
*/<br />
define('NET_SAMPLE_OK', 1);<br />
<br />
// }}}<br />
// {{{ GLOBALS<br />
<br />
/**<br />
* The number of objects created<br />
* @global int $GLOBALS['_NET_SAMPLE_Count']<br />
*/<br />
$GLOBALS['_NET_SAMPLE_Count'] = 0;<br />
<br />
// }}}<br />
// {{{ Net_Sample<br />
<br />
/**<br />
* An example of how to write code to PEAR's standards<br />
*<br />
* Docblock comments start with "/**" at the top. Notice how the "/"<br />
* lines up with the normal indenting and the asterisks on subsequent rows<br />
* are in line with the first asterisk. The last line of comment text<br />
* should be immediately followed on the next line by the closing asterisk<br />
* and slash and then the item you are commenting on should be on the next<br />
* line below that. Don't add extra lines. Please put a blank line<br />
* between paragraphs as well as between the end of the description and<br />
* the start of the @tags. Wrap comments before 80 columns in order to<br />
* ease readability for a wide variety of users.<br />
*<br />
* Docblocks can only be used for programming constructs which allow them<br />
* (classes, properties, methods, defines, includes, globals). See the<br />
* phpDocumentor documentation for more information.<br />
* http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html<br />
*<br />
* The Javadoc Style Guide is an excellent resource for figuring out<br />
* how to say what needs to be said in docblock comments. Much of what is<br />
* written here is a summary of what is found there, though there are some<br />
* cases where what's said here overrides what is said there.<br />
* http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#styleguide<br />
*<br />
* The first line of any docblock is the summary. Make them one short<br />
* sentence, without a period at the end. Summaries for classes, properties<br />
* and constants should omit the subject and simply state the object,<br />
* because they are describing things rather than actions or behaviors.<br />
*<br />
* Below are the tags commonly used for classes. @category through @version<br />
* are required. The remainder should only be used when necessary.<br />
* Please use them in the order they appear here. phpDocumentor has<br />
* several other tags available, feel free to use them.<br />
*<br />
* @category CategoryName<br />
* @package PackageName<br />
* @author Original Author <author@example.com><br />
* @author Another Author <another@example.com><br />
* @copyright 1997-2005 The PHP Group<br />
* @license http://www.php.net/license/3_01.txt PHP License 3.01<br />
* @version Release: @package_version@<br />
* @link http://pear.php.net/package/PackageName<br />
* @see NetOther, Net_Sample::Net_Sample()<br />
* @since Class available since Release 1.2.0<br />
* @deprecated Class deprecated in Release 2.0.0<br />
*/<br />
class Net_Sample<br />
{<br />
// {{{ properties<br />
<br />
/**<br />
* The status of foo's universe<br />
*<br />
* Potential values are 'good', 'fair', 'poor' and 'unknown'.<br />
*<br />
* @var string<br />
*/<br />
var $foo = 'unknown';<br />
<br />
/**<br />
* The status of life<br />
*<br />
* Note that names of private properties or methods must be<br />
* preceeded by an underscore.<br />
*<br />
* @var bool<br />
* @access private<br />
*/<br />
var $_good = true;<br />
<br />
// }}}<br />
// {{{ setFoo()<br />
<br />
/**<br />
* Registers the status of foo's universe<br />
*<br />
* Summaries for methods should use 3rd person declarative rather<br />
* than 2nd person imperative, beginning with a verb phrase.<br />
*<br />
* Summaries should add description beyond the method's name. The<br />
* best method names are "self-documenting", meaning they tell you<br />
* basically what the method does. If the summary merely repeats<br />
* the method name in sentence form, it is not providing more<br />
* information.<br />
*<br />
* Summary Examples:<br />
* + Sets the label (preferred)<br />
* + Set the label (avoid)<br />
* + This method sets the label (avoid)<br />
*<br />
* Below are the tags commonly used for methods. A @param tag is<br />
* required for each parameter the method has. The @return<br />
* and @access tags are mandatory. The @throws tag is required if<br />
* the method uses exceptions. @static is required if the method can<br />
* be called statically. The remainder should only be used when<br />
* necessary. Please use them in the order they appear here.<br />
* phpDocumentor has several other tags available, feel free to use<br />
* them.<br />
*<br />
* The @param tag contains the data type, then the parameter's<br />
* name, followed by a description. By convention, the first noun in<br />
* the description is the data type of the parameter. Articles like<br />
* "a", "an", and "the" can precede the noun. The descriptions<br />
* should start with a phrase. If further description is necessary,<br />
* follow with sentences. Having two spaces between the name and the<br />
* description aids readability.<br />
*<br />
* When writing a phrase, do not capitalize and do not end with a<br />
* period:<br />
* + the string to be tested<br />
*<br />
* When writing a phrase followed by a sentence, do not capitalize the<br />
* phrase, but end it with a period to distinguish it from the start<br />
* of the next sentence:<br />
* + the string to be tested. Must use UTF-8 encoding.<br />
*<br />
* Return tags should contain the data type then a description of<br />
* the data returned. The data type can be any of PHP's data types<br />
* (int, float, bool, string, array, object, resource, mixed)<br />
* and should contain the type primarily returned. For example, if<br />
* a method returns an object when things work correctly but false<br />
* when an error happens, say 'object' rather than 'mixed.' Use<br />
* 'void' if nothing is returned.<br />
*<br />
* Here's an example of how to format examples:<br />
* <code><br />
* require_once 'Net/Sample.php';<br />
*<br />
* $s = new Net_Sample();<br />
* if (PEAR::isError($s)) {<br />
* echo $s->getMessage() . "\n";<br />
* }<br />
* </code><br />
*<br />
* Here is an example for non-php example or sample:<br />
* <samp><br />
* pear install net_sample<br />
* </samp><br />
*<br />
* @param string $arg1 the string to quote<br />
* @param int $arg2 an integer of how many problems happened.<br />
* Indent to the description's starting point<br />
* for long ones.<br />
*<br />
* @return int the integer of the set mode used. FALSE if foo<br />
* foo could not be set.<br />
* @throws exceptionclass [description]<br />
*<br />
* @access public<br />
* @static<br />
* @see Net_Sample::$foo, Net_Other::someMethod()<br />
* @since Method available since Release 1.2.0<br />
* @deprecated Method deprecated in Release 2.0.0<br />
*/<br />
function setFoo($arg1, $arg2 = 0)<br />
{<br />
/*<br />
* This is a "Block Comment." The format is the same as<br />
* Docblock Comments except there is only one asterisk at the<br />
* top. phpDocumentor doesn't parse these.<br />
*/<br />
if ($arg1 == 'good' || $arg1 == 'fair') {<br />
$this->foo = $arg1;<br />
return 1;<br />
} elseif ($arg1 == 'poor' && $arg2 > 1) {<br />
$this->foo = 'poor';<br />
return 2;<br />
} else {<br />
return false;<br />
}<br />
}<br />
<br />
// }}}<br />
}<br />
<br />
// }}}<br />
<br />
/*<br />
* Local variables:<br />
* tab-width: 4<br />
* c-basic-offset: 4<br />
* c-hanging-comment-ender-p: nil<br />
* End:<br />
*/<br />
<br />
?></source></div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7047
Protoss/规范/代码规范
2010-08-20T04:23:07Z
<p>SnakeZero：/* 全文示例 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 基本命名规则 ==<br />
=== 全局变量和函数命名 ===<br />
如果你需要定义一个全局变量的话,应当以美元符号加下划线“$_”开头，后接包名。例如,PEAR包中一个变量就作：$_PEAR_destructor_object_list.<br />
<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
所有需要包含在PEAR核心发布的PHP代码文件，在文件开始的时候，你必须加入以下的注释声明：<br />
<source lang="php">/* vim: set expandtab tabstop=4 shiftwidth=4: */<br />
// +----------------------------------------------------------------------+<br />
// | PHP version 4.0 |<br />
// +----------------------------------------------------------------------+<br />
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |<br />
// +----------------------------------------------------------------------+<br />
// | This source file is subject to version 2.0 of the PHP license, |<br />
// | that is bundled with this package in the file LICENSE, and is |<br />
// | available at through the world-wide-web at |<br />
// | http://www.php.net/license/2_02.txt. |<br />
// | If you did not receive a copy of the PHP license and are unable to |<br />
// | obtain it through the world-wide-web, please send a note to |<br />
// | license@php.net so we can mail you a copy immediately. |<br />
// +----------------------------------------------------------------------+<br />
// | Authors: 组织机构名称 |<br />
// | Snake.Zero -- Orochi the Great |<br />
// +----------------------------------------------------------------------+<br />
//<br />
// $Id$<br />
</source><br />
对于不在PEAR核心代码库中的文件，建议你也在文件的开始处有这样一个类似的注释块，标明版权，协议，作者等等。同时也在第一行加入VIM的MODELINE，这样在VIM中能够保持PEAR的代码风格。<br/><br />
* CVS标记：<br />
如上面所展示那样，在每个文件中加入CVS的ID标记，如果你编辑或修改的文件中没有这个标记，那么请加入，或者是替换原文件中相类似的表现形式（如"Last modified"等等）<br />
* URL样本：<br />
你可以参照RFC 2606,使用"www.example.com"作为所有的URL样本。<br />
* 常量命名：<br />
常量应该尽量使用大写，为了便于理解，使用下划线分割每个单词。同时，你应该常量所在的包名或者是类名作为前缀。比如，对于Bug类中常量应该以Bug_开始。以上是PEAR的编码规则，详细的编码规则可以参考PEAR中的CODING_STANDDARD文件的说明。为了更好地理解这些编码规则，你也可以参考一下现有PEAR核心模块的代码。<br />
<br />
== 文件的相关规范 ==<br />
* 所有文件必须是unix文件格式<br />
* 所有文件编码必须是UTF-8<br />
* 文件以ASCII码来存储<br />
<br />
== 全文示例 ==<br />
<source lang="php"><br />
<?php<br />
<br />
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */<br />
<br />
/**<br />
* Short description for file<br />
*<br />
* Long description for file (if any)...<br />
*<br />
* PHP version 5<br />
*<br />
* LICENSE: This source file is subject to version 3.01 of the PHP license<br />
* that is available through the world-wide-web at the following URI:<br />
* http://www.php.net/license/3_01.txt. If you did not receive a copy of<br />
* the PHP License and are unable to obtain it through the web, please<br />
* send a note to license@php.net so we can mail you a copy immediately.<br />
*<br />
* @category CategoryName<br />
* @package PackageName<br />
* @author Original Author <author@example.com><br />
* @author Another Author <another@example.com><br />
* @copyright 1997-2005 The PHP Group<br />
* @license http://www.php.net/license/3_01.txt PHP License 3.01<br />
* @version CVS: <?php<br />
$<br />
?> Id:$<br />
* @link http://pear.php.net/package/PackageName<br />
* @see NetOther, Net_Sample::Net_Sample()<br />
* @since File available since Release 1.2.0<br />
* @deprecated File deprecated in Release 2.0.0<br />
*/<br />
<br />
/**<br />
* This is a "Docblock Comment," also known as a "docblock." The class'<br />
* docblock, below, contains a complete description of how to write these.<br />
*/<br />
require_once 'PEAR.php';<br />
<br />
// {{{ constants<br />
<br />
/**<br />
* Methods return this if they succeed<br />
*/<br />
define('NET_SAMPLE_OK', 1);<br />
<br />
// }}}<br />
// {{{ GLOBALS<br />
<br />
/**<br />
* The number of objects created<br />
* @global int $GLOBALS['_NET_SAMPLE_Count']<br />
*/<br />
$GLOBALS['_NET_SAMPLE_Count'] = 0;<br />
<br />
// }}}<br />
// {{{ Net_Sample<br />
<br />
/**<br />
* An example of how to write code to PEAR's standards<br />
*<br />
* Docblock comments start with "/**" at the top. Notice how the "/"<br />
* lines up with the normal indenting and the asterisks on subsequent rows<br />
* are in line with the first asterisk. The last line of comment text<br />
* should be immediately followed on the next line by the closing asterisk<br />
* and slash and then the item you are commenting on should be on the next<br />
* line below that. Don't add extra lines. Please put a blank line<br />
* between paragraphs as well as between the end of the description and<br />
* the start of the @tags. Wrap comments before 80 columns in order to<br />
* ease readability for a wide variety of users.<br />
*<br />
* Docblocks can only be used for programming constructs which allow them<br />
* (classes, properties, methods, defines, includes, globals). See the<br />
* phpDocumentor documentation for more information.<br />
* http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html<br />
*<br />
* The Javadoc Style Guide is an excellent resource for figuring out<br />
* how to say what needs to be said in docblock comments. Much of what is<br />
* written here is a summary of what is found there, though there are some<br />
* cases where what's said here overrides what is said there.<br />
* http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#styleguide<br />
*<br />
* The first line of any docblock is the summary. Make them one short<br />
* sentence, without a period at the end. Summaries for classes, properties<br />
* and constants should omit the subject and simply state the object,<br />
* because they are describing things rather than actions or behaviors.<br />
*<br />
* Below are the tags commonly used for classes. @category through @version<br />
* are required. The remainder should only be used when necessary.<br />
* Please use them in the order they appear here. phpDocumentor has<br />
* several other tags available, feel free to use them.<br />
*<br />
* @category CategoryName<br />
* @package PackageName<br />
* @author Original Author <author@example.com><br />
* @author Another Author <another@example.com><br />
* @copyright 1997-2005 The PHP Group<br />
* @license http://www.php.net/license/3_01.txt PHP License 3.01<br />
* @version Release: @package_version@<br />
* @link http://pear.php.net/package/PackageName<br />
* @see NetOther, Net_Sample::Net_Sample()<br />
* @since Class available since Release 1.2.0<br />
* @deprecated Class deprecated in Release 2.0.0<br />
*/<br />
class Net_Sample<br />
{<br />
// {{{ properties<br />
<br />
/**<br />
* The status of foo's universe<br />
*<br />
* Potential values are 'good', 'fair', 'poor' and 'unknown'.<br />
*<br />
* @var string<br />
*/<br />
var $foo = 'unknown';<br />
<br />
/**<br />
* The status of life<br />
*<br />
* Note that names of private properties or methods must be<br />
* preceeded by an underscore.<br />
*<br />
* @var bool<br />
* @access private<br />
*/<br />
var $_good = true;<br />
<br />
// }}}<br />
// {{{ setFoo()<br />
<br />
/**<br />
* Registers the status of foo's universe<br />
*<br />
* Summaries for methods should use 3rd person declarative rather<br />
* than 2nd person imperative, beginning with a verb phrase.<br />
*<br />
* Summaries should add description beyond the method's name. The<br />
* best method names are "self-documenting", meaning they tell you<br />
* basically what the method does. If the summary merely repeats<br />
* the method name in sentence form, it is not providing more<br />
* information.<br />
*<br />
* Summary Examples:<br />
* + Sets the label (preferred)<br />
* + Set the label (avoid)<br />
* + This method sets the label (avoid)<br />
*<br />
* Below are the tags commonly used for methods. A @param tag is<br />
* required for each parameter the method has. The @return<br />
* and @access tags are mandatory. The @throws tag is required if<br />
* the method uses exceptions. @static is required if the method can<br />
* be called statically. The remainder should only be used when<br />
* necessary. Please use them in the order they appear here.<br />
* phpDocumentor has several other tags available, feel free to use<br />
* them.<br />
*<br />
* The @param tag contains the data type, then the parameter's<br />
* name, followed by a description. By convention, the first noun in<br />
* the description is the data type of the parameter. Articles like<br />
* "a", "an", and "the" can precede the noun. The descriptions<br />
* should start with a phrase. If further description is necessary,<br />
* follow with sentences. Having two spaces between the name and the<br />
* description aids readability.<br />
*<br />
* When writing a phrase, do not capitalize and do not end with a<br />
* period:<br />
* + the string to be tested<br />
*<br />
* When writing a phrase followed by a sentence, do not capitalize the<br />
* phrase, but end it with a period to distinguish it from the start<br />
* of the next sentence:<br />
* + the string to be tested. Must use UTF-8 encoding.<br />
*<br />
* Return tags should contain the data type then a description of<br />
* the data returned. The data type can be any of PHP's data types<br />
* (int, float, bool, string, array, object, resource, mixed)<br />
* and should contain the type primarily returned. For example, if<br />
* a method returns an object when things work correctly but false<br />
* when an error happens, say 'object' rather than 'mixed.' Use<br />
* 'void' if nothing is returned.<br />
*<br />
* Here's an example of how to format examples:<br />
* <code><br />
* require_once 'Net/Sample.php';<br />
*<br />
* $s = new Net_Sample();<br />
* if (PEAR::isError($s)) {<br />
* echo $s->getMessage() . "\n";<br />
* }<br />
* </code><br />
*<br />
* Here is an example for non-php example or sample:<br />
* <samp><br />
* pear install net_sample<br />
* </samp><br />
*<br />
* @param string $arg1 the string to quote<br />
* @param int $arg2 an integer of how many problems happened.<br />
* Indent to the description's starting point<br />
* for long ones.<br />
*<br />
* @return int the integer of the set mode used. FALSE if foo<br />
* foo could not be set.<br />
* @throws exceptionclass [description]<br />
*<br />
* @access public<br />
* @static<br />
* @see Net_Sample::$foo, Net_Other::someMethod()<br />
* @since Method available since Release 1.2.0<br />
* @deprecated Method deprecated in Release 2.0.0<br />
*/<br />
function setFoo($arg1, $arg2 = 0)<br />
{<br />
/*<br />
* This is a "Block Comment." The format is the same as<br />
* Docblock Comments except there is only one asterisk at the<br />
* top. phpDocumentor doesn't parse these.<br />
*/<br />
if ($arg1 == 'good' || $arg1 == 'fair') {<br />
$this->foo = $arg1;<br />
return 1;<br />
} elseif ($arg1 == 'poor' && $arg2 > 1) {<br />
$this->foo = 'poor';<br />
return 2;<br />
} else {<br />
return false;<br />
}<br />
}<br />
<br />
// }}}<br />
}<br />
<br />
// }}}<br />
<br />
/*<br />
* Local variables:<br />
* tab-width: 4<br />
* c-basic-offset: 4<br />
* c-hanging-comment-ender-p: nil<br />
* End:<br />
*/<br />
<br />
?></source></div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7046
Protoss/规范/代码规范
2010-08-20T04:22:16Z
<p>SnakeZero：</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 基本命名规则 ==<br />
=== 全局变量和函数命名 ===<br />
如果你需要定义一个全局变量的话,应当以美元符号加下划线“$_”开头，后接包名。例如,PEAR包中一个变量就作：$_PEAR_destructor_object_list.<br />
<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
所有需要包含在PEAR核心发布的PHP代码文件，在文件开始的时候，你必须加入以下的注释声明：<br />
<source lang="php">/* vim: set expandtab tabstop=4 shiftwidth=4: */<br />
// +----------------------------------------------------------------------+<br />
// | PHP version 4.0 |<br />
// +----------------------------------------------------------------------+<br />
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |<br />
// +----------------------------------------------------------------------+<br />
// | This source file is subject to version 2.0 of the PHP license, |<br />
// | that is bundled with this package in the file LICENSE, and is |<br />
// | available at through the world-wide-web at |<br />
// | http://www.php.net/license/2_02.txt. |<br />
// | If you did not receive a copy of the PHP license and are unable to |<br />
// | obtain it through the world-wide-web, please send a note to |<br />
// | license@php.net so we can mail you a copy immediately. |<br />
// +----------------------------------------------------------------------+<br />
// | Authors: 组织机构名称 |<br />
// | Snake.Zero -- Orochi the Great |<br />
// +----------------------------------------------------------------------+<br />
//<br />
// $Id$<br />
</source><br />
对于不在PEAR核心代码库中的文件，建议你也在文件的开始处有这样一个类似的注释块，标明版权，协议，作者等等。同时也在第一行加入VIM的MODELINE，这样在VIM中能够保持PEAR的代码风格。<br/><br />
* CVS标记：<br />
如上面所展示那样，在每个文件中加入CVS的ID标记，如果你编辑或修改的文件中没有这个标记，那么请加入，或者是替换原文件中相类似的表现形式（如"Last modified"等等）<br />
* URL样本：<br />
你可以参照RFC 2606,使用"www.example.com"作为所有的URL样本。<br />
* 常量命名：<br />
常量应该尽量使用大写，为了便于理解，使用下划线分割每个单词。同时，你应该常量所在的包名或者是类名作为前缀。比如，对于Bug类中常量应该以Bug_开始。以上是PEAR的编码规则，详细的编码规则可以参考PEAR中的CODING_STANDDARD文件的说明。为了更好地理解这些编码规则，你也可以参考一下现有PEAR核心模块的代码。<br />
<br />
== 文件的相关规范 ==<br />
* 所有文件必须是unix文件格式<br />
* 所有文件编码必须是UTF-8<br />
* 文件以ASCII码来存储<br />
<br />
== 全文示例 ==<br />
<source_lang="php"><br />
<?php<br />
<br />
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */<br />
<br />
/**<br />
* Short description for file<br />
*<br />
* Long description for file (if any)...<br />
*<br />
* PHP version 5<br />
*<br />
* LICENSE: This source file is subject to version 3.01 of the PHP license<br />
* that is available through the world-wide-web at the following URI:<br />
* http://www.php.net/license/3_01.txt. If you did not receive a copy of<br />
* the PHP License and are unable to obtain it through the web, please<br />
* send a note to license@php.net so we can mail you a copy immediately.<br />
*<br />
* @category CategoryName<br />
* @package PackageName<br />
* @author Original Author <author@example.com><br />
* @author Another Author <another@example.com><br />
* @copyright 1997-2005 The PHP Group<br />
* @license http://www.php.net/license/3_01.txt PHP License 3.01<br />
* @version CVS: <?php<br />
$<br />
?> Id:$<br />
* @link http://pear.php.net/package/PackageName<br />
* @see NetOther, Net_Sample::Net_Sample()<br />
* @since File available since Release 1.2.0<br />
* @deprecated File deprecated in Release 2.0.0<br />
*/<br />
<br />
/**<br />
* This is a "Docblock Comment," also known as a "docblock." The class'<br />
* docblock, below, contains a complete description of how to write these.<br />
*/<br />
require_once 'PEAR.php';<br />
<br />
// {{{ constants<br />
<br />
/**<br />
* Methods return this if they succeed<br />
*/<br />
define('NET_SAMPLE_OK', 1);<br />
<br />
// }}}<br />
// {{{ GLOBALS<br />
<br />
/**<br />
* The number of objects created<br />
* @global int $GLOBALS['_NET_SAMPLE_Count']<br />
*/<br />
$GLOBALS['_NET_SAMPLE_Count'] = 0;<br />
<br />
// }}}<br />
// {{{ Net_Sample<br />
<br />
/**<br />
* An example of how to write code to PEAR's standards<br />
*<br />
* Docblock comments start with "/**" at the top. Notice how the "/"<br />
* lines up with the normal indenting and the asterisks on subsequent rows<br />
* are in line with the first asterisk. The last line of comment text<br />
* should be immediately followed on the next line by the closing asterisk<br />
* and slash and then the item you are commenting on should be on the next<br />
* line below that. Don't add extra lines. Please put a blank line<br />
* between paragraphs as well as between the end of the description and<br />
* the start of the @tags. Wrap comments before 80 columns in order to<br />
* ease readability for a wide variety of users.<br />
*<br />
* Docblocks can only be used for programming constructs which allow them<br />
* (classes, properties, methods, defines, includes, globals). See the<br />
* phpDocumentor documentation for more information.<br />
* http://phpdoc.org/docs/HTMLSmartyConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html<br />
*<br />
* The Javadoc Style Guide is an excellent resource for figuring out<br />
* how to say what needs to be said in docblock comments. Much of what is<br />
* written here is a summary of what is found there, though there are some<br />
* cases where what's said here overrides what is said there.<br />
* http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#styleguide<br />
*<br />
* The first line of any docblock is the summary. Make them one short<br />
* sentence, without a period at the end. Summaries for classes, properties<br />
* and constants should omit the subject and simply state the object,<br />
* because they are describing things rather than actions or behaviors.<br />
*<br />
* Below are the tags commonly used for classes. @category through @version<br />
* are required. The remainder should only be used when necessary.<br />
* Please use them in the order they appear here. phpDocumentor has<br />
* several other tags available, feel free to use them.<br />
*<br />
* @category CategoryName<br />
* @package PackageName<br />
* @author Original Author <author@example.com><br />
* @author Another Author <another@example.com><br />
* @copyright 1997-2005 The PHP Group<br />
* @license http://www.php.net/license/3_01.txt PHP License 3.01<br />
* @version Release: @package_version@<br />
* @link http://pear.php.net/package/PackageName<br />
* @see NetOther, Net_Sample::Net_Sample()<br />
* @since Class available since Release 1.2.0<br />
* @deprecated Class deprecated in Release 2.0.0<br />
*/<br />
class Net_Sample<br />
{<br />
// {{{ properties<br />
<br />
/**<br />
* The status of foo's universe<br />
*<br />
* Potential values are 'good', 'fair', 'poor' and 'unknown'.<br />
*<br />
* @var string<br />
*/<br />
var $foo = 'unknown';<br />
<br />
/**<br />
* The status of life<br />
*<br />
* Note that names of private properties or methods must be<br />
* preceeded by an underscore.<br />
*<br />
* @var bool<br />
* @access private<br />
*/<br />
var $_good = true;<br />
<br />
// }}}<br />
// {{{ setFoo()<br />
<br />
/**<br />
* Registers the status of foo's universe<br />
*<br />
* Summaries for methods should use 3rd person declarative rather<br />
* than 2nd person imperative, beginning with a verb phrase.<br />
*<br />
* Summaries should add description beyond the method's name. The<br />
* best method names are "self-documenting", meaning they tell you<br />
* basically what the method does. If the summary merely repeats<br />
* the method name in sentence form, it is not providing more<br />
* information.<br />
*<br />
* Summary Examples:<br />
* + Sets the label (preferred)<br />
* + Set the label (avoid)<br />
* + This method sets the label (avoid)<br />
*<br />
* Below are the tags commonly used for methods. A @param tag is<br />
* required for each parameter the method has. The @return<br />
* and @access tags are mandatory. The @throws tag is required if<br />
* the method uses exceptions. @static is required if the method can<br />
* be called statically. The remainder should only be used when<br />
* necessary. Please use them in the order they appear here.<br />
* phpDocumentor has several other tags available, feel free to use<br />
* them.<br />
*<br />
* The @param tag contains the data type, then the parameter's<br />
* name, followed by a description. By convention, the first noun in<br />
* the description is the data type of the parameter. Articles like<br />
* "a", "an", and "the" can precede the noun. The descriptions<br />
* should start with a phrase. If further description is necessary,<br />
* follow with sentences. Having two spaces between the name and the<br />
* description aids readability.<br />
*<br />
* When writing a phrase, do not capitalize and do not end with a<br />
* period:<br />
* + the string to be tested<br />
*<br />
* When writing a phrase followed by a sentence, do not capitalize the<br />
* phrase, but end it with a period to distinguish it from the start<br />
* of the next sentence:<br />
* + the string to be tested. Must use UTF-8 encoding.<br />
*<br />
* Return tags should contain the data type then a description of<br />
* the data returned. The data type can be any of PHP's data types<br />
* (int, float, bool, string, array, object, resource, mixed)<br />
* and should contain the type primarily returned. For example, if<br />
* a method returns an object when things work correctly but false<br />
* when an error happens, say 'object' rather than 'mixed.' Use<br />
* 'void' if nothing is returned.<br />
*<br />
* Here's an example of how to format examples:<br />
* <code><br />
* require_once 'Net/Sample.php';<br />
*<br />
* $s = new Net_Sample();<br />
* if (PEAR::isError($s)) {<br />
* echo $s->getMessage() . "\n";<br />
* }<br />
* </code><br />
*<br />
* Here is an example for non-php example or sample:<br />
* <samp><br />
* pear install net_sample<br />
* </samp><br />
*<br />
* @param string $arg1 the string to quote<br />
* @param int $arg2 an integer of how many problems happened.<br />
* Indent to the description's starting point<br />
* for long ones.<br />
*<br />
* @return int the integer of the set mode used. FALSE if foo<br />
* foo could not be set.<br />
* @throws exceptionclass [description]<br />
*<br />
* @access public<br />
* @static<br />
* @see Net_Sample::$foo, Net_Other::someMethod()<br />
* @since Method available since Release 1.2.0<br />
* @deprecated Method deprecated in Release 2.0.0<br />
*/<br />
function setFoo($arg1, $arg2 = 0)<br />
{<br />
/*<br />
* This is a "Block Comment." The format is the same as<br />
* Docblock Comments except there is only one asterisk at the<br />
* top. phpDocumentor doesn't parse these.<br />
*/<br />
if ($arg1 == 'good' || $arg1 == 'fair') {<br />
$this->foo = $arg1;<br />
return 1;<br />
} elseif ($arg1 == 'poor' && $arg2 > 1) {<br />
$this->foo = 'poor';<br />
return 2;<br />
} else {<br />
return false;<br />
}<br />
}<br />
<br />
// }}}<br />
}<br />
<br />
// }}}<br />
<br />
/*<br />
* Local variables:<br />
* tab-width: 4<br />
* c-basic-offset: 4<br />
* c-hanging-comment-ender-p: nil<br />
* End:<br />
*/<br />
<br />
?></source></div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7045
Protoss/规范/代码规范
2010-08-20T04:21:17Z
<p>SnakeZero：/* 变量 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 基本命名规则 ==<br />
=== 全局变量和函数命名 ===<br />
如果你需要定义一个全局变量的话,应当以美元符号加下划线“$_”开头，后接包名。例如,PEAR包中一个变量就作：$_PEAR_destructor_object_list.<br />
<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
所有需要包含在PEAR核心发布的PHP代码文件，在文件开始的时候，你必须加入以下的注释声明：<br />
<source lang="php">/* vim: set expandtab tabstop=4 shiftwidth=4: */<br />
// +----------------------------------------------------------------------+<br />
// | PHP version 4.0 |<br />
// +----------------------------------------------------------------------+<br />
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |<br />
// +----------------------------------------------------------------------+<br />
// | This source file is subject to version 2.0 of the PHP license, |<br />
// | that is bundled with this package in the file LICENSE, and is |<br />
// | available at through the world-wide-web at |<br />
// | http://www.php.net/license/2_02.txt. |<br />
// | If you did not receive a copy of the PHP license and are unable to |<br />
// | obtain it through the world-wide-web, please send a note to |<br />
// | license@php.net so we can mail you a copy immediately. |<br />
// +----------------------------------------------------------------------+<br />
// | Authors: 组织机构名称 |<br />
// | Snake.Zero -- Orochi the Great |<br />
// +----------------------------------------------------------------------+<br />
//<br />
// $Id$<br />
</source><br />
对于不在PEAR核心代码库中的文件，建议你也在文件的开始处有这样一个类似的注释块，标明版权，协议，作者等等。同时也在第一行加入VIM的MODELINE，这样在VIM中能够保持PEAR的代码风格。<br/><br />
* CVS标记：<br />
如上面所展示那样，在每个文件中加入CVS的ID标记，如果你编辑或修改的文件中没有这个标记，那么请加入，或者是替换原文件中相类似的表现形式（如"Last modified"等等）<br />
* URL样本：<br />
你可以参照RFC 2606,使用"www.example.com"作为所有的URL样本。<br />
* 常量命名：<br />
常量应该尽量使用大写，为了便于理解，使用下划线分割每个单词。同时，你应该常量所在的包名或者是类名作为前缀。比如，对于Bug类中常量应该以Bug_开始。以上是PEAR的编码规则，详细的编码规则可以参考PEAR中的CODING_STANDDARD文件的说明。为了更好地理解这些编码规则，你也可以参考一下现有PEAR核心模块的代码。<br />
<br />
== 文件的相关规范 ==<br />
* 所有文件必须是unix文件格式<br />
* 所有文件编码必须是UTF-8<br />
* 文件以ASCII码来存储</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7044
Protoss/规范/代码规范
2010-08-20T04:15:10Z
<p>SnakeZero：</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 变量 ==<br />
<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
所有需要包含在PEAR核心发布的PHP代码文件，在文件开始的时候，你必须加入以下的注释声明：<br />
<source lang="php">/* vim: set expandtab tabstop=4 shiftwidth=4: */<br />
// +----------------------------------------------------------------------+<br />
// | PHP version 4.0 |<br />
// +----------------------------------------------------------------------+<br />
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |<br />
// +----------------------------------------------------------------------+<br />
// | This source file is subject to version 2.0 of the PHP license, |<br />
// | that is bundled with this package in the file LICENSE, and is |<br />
// | available at through the world-wide-web at |<br />
// | http://www.php.net/license/2_02.txt. |<br />
// | If you did not receive a copy of the PHP license and are unable to |<br />
// | obtain it through the world-wide-web, please send a note to |<br />
// | license@php.net so we can mail you a copy immediately. |<br />
// +----------------------------------------------------------------------+<br />
// | Authors: 组织机构名称 |<br />
// | Snake.Zero -- Orochi the Great |<br />
// +----------------------------------------------------------------------+<br />
//<br />
// $Id$<br />
</source><br />
对于不在PEAR核心代码库中的文件，建议你也在文件的开始处有这样一个类似的注释块，标明版权，协议，作者等等。同时也在第一行加入VIM的MODELINE，这样在VIM中能够保持PEAR的代码风格。<br/><br />
* CVS标记：<br />
如上面所展示那样，在每个文件中加入CVS的ID标记，如果你编辑或修改的文件中没有这个标记，那么请加入，或者是替换原文件中相类似的表现形式（如"Last modified"等等）<br />
* URL样本：<br />
你可以参照RFC 2606,使用"www.example.com"作为所有的URL样本。<br />
* 常量命名：<br />
常量应该尽量使用大写，为了便于理解，使用下划线分割每个单词。同时，你应该常量所在的包名或者是类名作为前缀。比如，对于Bug类中常量应该以Bug_开始。以上是PEAR的编码规则，详细的编码规则可以参考PEAR中的CODING_STANDDARD文件的说明。为了更好地理解这些编码规则，你也可以参考一下现有PEAR核心模块的代码。<br />
<br />
== 文件的相关规范 ==<br />
* 所有文件必须是unix文件格式<br />
* 所有文件编码必须是UTF-8<br />
* 文件以ASCII码来存储</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7043
Protoss/规范/代码规范
2010-08-20T04:11:19Z
<p>SnakeZero：/* 文件的相关规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
所有需要包含在PEAR核心发布的PHP代码文件，在文件开始的时候，你必须加入以下的注释声明：<br />
<source lang="php">/* vim: set expandtab tabstop=4 shiftwidth=4: */<br />
// +----------------------------------------------------------------------+<br />
// | PHP version 4.0 |<br />
// +----------------------------------------------------------------------+<br />
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |<br />
// +----------------------------------------------------------------------+<br />
// | This source file is subject to version 2.0 of the PHP license, |<br />
// | that is bundled with this package in the file LICENSE, and is |<br />
// | available at through the world-wide-web at |<br />
// | http://www.php.net/license/2_02.txt. |<br />
// | If you did not receive a copy of the PHP license and are unable to |<br />
// | obtain it through the world-wide-web, please send a note to |<br />
// | license@php.net so we can mail you a copy immediately. |<br />
// +----------------------------------------------------------------------+<br />
// | Authors: 组织机构名称 |<br />
// | Snake.Zero -- Orochi the Great |<br />
// +----------------------------------------------------------------------+<br />
//<br />
// $Id$<br />
</source><br />
对于不在PEAR核心代码库中的文件，建议你也在文件的开始处有这样一个类似的注释块，标明版权，协议，作者等等。同时也在第一行加入VIM的MODELINE，这样在VIM中能够保持PEAR的代码风格。<br/><br />
* CVS标记：<br />
如上面所展示那样，在每个文件中加入CVS的ID标记，如果你编辑或修改的文件中没有这个标记，那么请加入，或者是替换原文件中相类似的表现形式（如"Last modified"等等）<br />
* URL样本：<br />
你可以参照RFC 2606,使用"www.example.com"作为所有的URL样本。<br />
* 常量命名：<br />
常量应该尽量使用大写，为了便于理解，使用下划线分割每个单词。同时，你应该常量所在的包名或者是类名作为前缀。比如，对于Bug类中常量应该以Bug_开始。以上是PEAR的编码规则，详细的编码规则可以参考PEAR中的CODING_STANDDARD文件的说明。为了更好地理解这些编码规则，你也可以参考一下现有PEAR核心模块的代码。<br />
<br />
== 文件的相关规范 ==<br />
* 所有文件必须是unix文件格式<br />
* 所有文件编码必须是UTF-8<br />
* 文件以ASCII码来存储</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7042
Protoss/规范/代码规范
2010-08-20T04:06:24Z
<p>SnakeZero：/* 文件头部注释书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
所有需要包含在PEAR核心发布的PHP代码文件，在文件开始的时候，你必须加入以下的注释声明：<br />
<source lang="php">/* vim: set expandtab tabstop=4 shiftwidth=4: */<br />
// +----------------------------------------------------------------------+<br />
// | PHP version 4.0 |<br />
// +----------------------------------------------------------------------+<br />
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |<br />
// +----------------------------------------------------------------------+<br />
// | This source file is subject to version 2.0 of the PHP license, |<br />
// | that is bundled with this package in the file LICENSE, and is |<br />
// | available at through the world-wide-web at |<br />
// | http://www.php.net/license/2_02.txt. |<br />
// | If you did not receive a copy of the PHP license and are unable to |<br />
// | obtain it through the world-wide-web, please send a note to |<br />
// | license@php.net so we can mail you a copy immediately. |<br />
// +----------------------------------------------------------------------+<br />
// | Authors: 组织机构名称 |<br />
// | Snake.Zero -- Orochi the Great |<br />
// +----------------------------------------------------------------------+<br />
//<br />
// $Id$<br />
</source><br />
对于不在PEAR核心代码库中的文件，建议你也在文件的开始处有这样一个类似的注释块，标明版权，协议，作者等等。同时也在第一行加入VIM的MODELINE，这样在VIM中能够保持PEAR的代码风格。<br/><br />
* CVS标记：<br />
如上面所展示那样，在每个文件中加入CVS的ID标记，如果你编辑或修改的文件中没有这个标记，那么请加入，或者是替换原文件中相类似的表现形式（如"Last modified"等等）<br />
* URL样本：<br />
你可以参照RFC 2606,使用"www.example.com"作为所有的URL样本。<br />
* 常量命名：<br />
常量应该尽量使用大写，为了便于理解，使用下划线分割每个单词。同时，你应该常量所在的包名或者是类名作为前缀。比如，对于Bug类中常量应该以Bug_开始。以上是PEAR的编码规则，详细的编码规则可以参考PEAR中的CODING_STANDDARD文件的说明。为了更好地理解这些编码规则，你也可以参考一下现有PEAR核心模块的代码。<br />
<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7041
Protoss/规范/代码规范
2010-08-20T04:05:16Z
<p>SnakeZero：/* 文件头部注释书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
<source lang="php">/* vim: set expandtab tabstop=4 shiftwidth=4: */<br />
// +----------------------------------------------------------------------+<br />
// | PHP version 4.0 |<br />
// +----------------------------------------------------------------------+<br />
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |<br />
// +----------------------------------------------------------------------+<br />
// | This source file is subject to version 2.0 of the PHP license, |<br />
// | that is bundled with this package in the file LICENSE, and is |<br />
// | available at through the world-wide-web at |<br />
// | http://www.php.net/license/2_02.txt. |<br />
// | If you did not receive a copy of the PHP license and are unable to |<br />
// | obtain it through the world-wide-web, please send a note to |<br />
// | license@php.net so we can mail you a copy immediately. |<br />
// +----------------------------------------------------------------------+<br />
// | Authors: 组织机构名称 |<br />
// | Snake.Zero -- Orochi the Great |<br />
// +----------------------------------------------------------------------+<br />
//<br />
// $Id$<br />
</source><br />
对于不在PEAR核心代码库中的文件，建议你也在文件的开始处有这样一个类似的注释块，标明版权，协议，作者等等。同时也在第一行加入VIM的MODELINE，这样在VIM中能够保持PEAR的代码风格。<br/><br />
* CVS标记：<br />
如上面所展示那样，在每个文件中加入CVS的ID标记，如果你编辑或修改的文件中没有这个标记，那么请加入，或者是替换原文件中相类似的表现形式（如"Last modified"等等）<br />
* URL样本：<br />
你可以参照RFC 2606,使用"www.example.com"作为所有的URL样本。<br />
* 常量命名：<br />
常量应该尽量使用大写，为了便于理解，使用下划线分割每个单词。同时，你应该常量所在的包名或者是类名作为前缀。比如，对于Bug类中常量应该以Bug_开始。以上是PEAR的编码规则，详细的编码规则可以参考PEAR中的CODING_STANDDARD文件的说明。为了更好地理解这些编码规则，你也可以参考一下现有PEAR核心模块的代码。<br />
<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7040
Protoss/规范/代码规范
2010-08-20T04:04:11Z
<p>SnakeZero：/* 文件头部注释书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
<source lang="php">/* vim: set expandtab tabstop=4 shiftwidth=4: */<br />
// +----------------------------------------------------------------------+<br />
// | PHP version 4.0 |<br />
// +----------------------------------------------------------------------+<br />
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |<br />
// +----------------------------------------------------------------------+<br />
// | This source file is subject to version 2.0 of the PHP license, |<br />
// | that is bundled with this package in the file LICENSE, and is |<br />
// | available at through the world-wide-web at |<br />
// | http://www.php.net/license/2_02.txt. |<br />
// | If you did not receive a copy of the PHP license and are unable to |<br />
// | obtain it through the world-wide-web, please send a note to |<br />
// | license@php.net so we can mail you a copy immediately. |<br />
// +----------------------------------------------------------------------+<br />
// | Authors: 组织机构名称 |<br />
// | Snake.Zero -- Orochi the Great |<br />
// +----------------------------------------------------------------------+<br />
//<br />
// $Id$<br />
</source><br />
对于不在PEAR核心代码库中的文件，建议你也在文件的开始处有这样一个类似的注释块，标明版权，协议，作者等等。同时也在第一行加入VIM的MODELINE，这样在VIM中能够保持PEAR的代码风格。<br />
CVS标记：<br />
如上面所展示那样，在每个文件中加入CVS的ID标记，如果你编辑或修改的文件中没有这个标记，那么请加入，或者是替换原文件中相类似的表现形式（如"Last modified"等等）<br />
URL样本：<br />
你可以参照RFC 2606,使用"www.example.com"作为所有的URL样本。<br />
常量命名：<br />
常量应该尽量使用大写，为了便于理解，使用下划线分割每个单词。同时，你应该常量所在的包名或者是类名作为前缀。比如，对于Bug类中常量应该以Bug_开始。以上是PEAR的编码规则，详细的编码规则可以参考PEAR中的CODING_STANDDARD文件的说明。为了更好地理解这些编码规则，你也可以参考一下现有PEAR核心模块的代码。<br />
<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7039
Protoss/规范/代码规范
2010-08-20T04:03:00Z
<p>SnakeZero：/* 文件头部注释书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
<source lang="php">/* vim: set expandtab tabstop=4 shiftwidth=4: */<br />
// +----------------------------------------------------------------------+<br />
// | PHP version 4.0 |<br />
// +----------------------------------------------------------------------+<br />
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |<br />
// +----------------------------------------------------------------------+<br />
// | This source file is subject to version 2.0 of the PHP license, |<br />
// | that is bundled with this package in the file LICENSE, and is |<br />
// | available at through the world-wide-web at |<br />
// | http://www.php.net/license/2_02.txt. |<br />
// | If you did not receive a copy of the PHP license and are unable to |<br />
// | obtain it through the world-wide-web, please send a note to |<br />
// | license@php.net so we can mail you a copy immediately. |<br />
// +----------------------------------------------------------------------+<br />
// | Authors: 组织机构名称 |<br />
// | Snake.Zero -- Orochi the Great |<br />
// +----------------------------------------------------------------------+<br />
//<br />
// $Id$<br />
</source><br />
<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7038
Protoss/规范/代码规范
2010-08-20T04:02:23Z
<p>SnakeZero：/* 文件头部注释书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
/* vim: set expandtab tabstop=4 shiftwidth=4: */<br />
// +----------------------------------------------------------------------+<br />
// | PHP version 4.0 |<br />
// +----------------------------------------------------------------------+<br />
// | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group |<br />
// +----------------------------------------------------------------------+<br />
// | This source file is subject to version 2.0 of the PHP license, |<br />
// | that is bundled with this package in the file LICENSE, and is |<br />
// | available at through the world-wide-web at |<br />
// | http://www.php.net/license/2_02.txt. |<br />
// | If you did not receive a copy of the PHP license and are unable to |<br />
// | obtain it through the world-wide-web, please send a note to |<br />
// | license@php.net so we can mail you a copy immediately. |<br />
// +----------------------------------------------------------------------+<br />
// | Authors: 组织机构名称 |<br />
// | Snake.Zero -- Orochi the Great |<br />
// +----------------------------------------------------------------------+<br />
//<br />
// $Id$<br />
<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7037
Protoss/规范/代码规范
2010-08-20T03:55:20Z
<p>SnakeZero：/* 载入文件的书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
{{notice|content=在Protoss中，不要用“include”或者“require”去包含一个按命名规则命名的类，因为当你使用new来实例化的时候，Protoss会自动载入文件。<br/><b>Protoss的上下文处理方式保证了它不会二次包含同一个文件。</b>它所包含的文件和类都会在上下文中注册。}}<br />
<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7036
Protoss/规范/代码规范
2010-08-20T03:52:00Z
<p>SnakeZero：/* 载入文件的书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
无论什么时候，当你需要无条件包含进一个class文件，你必须使用requre_once;当你需要条件包含进一个class文件，你必须使用include_once;这样可以保证你要包含的文件只会包含一次，并且这2个语句共用同一个文件列表，所以你无须担心二者会混淆，一旦require_once 包含了一个文件，include_once不会再重复包含相同的文件，反之亦然。<br />
<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7035
Protoss/规范/代码规范
2010-08-20T03:51:23Z
<p>SnakeZero：/* 注释的书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
对于类的在线文档，应该能够被PHPDoc转换，就象JavaDoc那样。[[http://www.phpdoc.org/ PHPDoc]]也是一个PEAR的应用程序，更详细的介绍你可以去 http://www.phpdoc.de/ 查看。除了类的在线文档，建议你应该使用非文档性质的注释来诠释你的代码，当你看到一段代码时想：哦，我想不需要在文档里去仔细描述它吧。那么你最好给这段代码作一个简单的注释，这样防止你会忘记它们是如何工作的。对于注释的形式，C的 /* */和C++的//都不错，不过，不要使用Perl或者shell的#注释方式。<br />
<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7034
Protoss/规范/代码规范
2010-08-20T03:48:23Z
<p>SnakeZero：/* 数组的书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7033
Protoss/规范/代码规范
2010-08-20T03:48:04Z
<p>SnakeZero：/* 定义函数的书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source_lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7032
Protoss/规范/代码规范
2010-08-20T03:47:45Z
<p>SnakeZero：/* 定义类的书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source_lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source_lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source_lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source_lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7031
Protoss/规范/代码规范
2010-08-20T03:45:38Z
<p>SnakeZero：/* 过长的语句要分行 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source_lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source_lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source_lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source_lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source_lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7030
Protoss/规范/代码规范
2010-08-20T03:43:08Z
<p>SnakeZero：/* 上下文对齐标准 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source_lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source_lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source_lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source_lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source_lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source_lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7029
Protoss/规范/代码规范
2010-08-20T03:34:34Z
<p>SnakeZero：/* 上下文对齐标准 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<source_lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source_lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
<br />
=== 过长的语句要分行 ===<br />
<source_lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source_lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source_lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source_lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source_lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source_lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7028
Protoss/规范/代码规范
2010-08-20T03:33:59Z
<p>SnakeZero：/* 数组的书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<source_lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source_lang="php"><br />
<br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
=== 过长的语句要分行 ===<br />
<source_lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source_lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source_lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source_lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source_lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
<source_lang="php"><br />
<?php<br />
<br />
$some_array = array(<br />
'foo' => 'bar',<br />
'spam' => 'ham',<br />
);<br />
</source><br />
数组中的对齐参照物为“=>”，符号左边至少要保证1个空格，而右边也需要1个空格。<br />
<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7027
Protoss/规范/代码规范
2010-08-20T03:32:06Z
<p>SnakeZero：/* 定义函数的书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<source_lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source_lang="php"><br />
<br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
=== 过长的语句要分行 ===<br />
<source_lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source_lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source_lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
带默认值的参数应当写的参数列表的最后几个。通常都要返回有意义的值。下面来看个长点的例子：<br />
<source_lang="php"><br />
<?php<br />
function connect(&$dsn, $persistent = false)<br />
{<br />
if (is_array($dsn)) {<br />
$dsninfo = &$dsn;<br />
} else {<br />
$dsninfo = DB::parseDSN($dsn);<br />
}<br />
<br />
if (!$dsninfo || !$dsninfo['phptype']) {<br />
return $this->raiseError();<br />
}<br />
<br />
return true;<br />
}<br />
</source><br />
=== 多行函数定义书写规范 ===<br />
老规矩，每行最多80个字符。超过的话，就要换行。注意几点：<br />
* 换行后的参数前要有4个空格<br />
* “)”应该和关键字“function”对齐<br />
* “)”和“{”之间要有1个空格<br />
<source_lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7026
Protoss/规范/代码规范
2010-08-20T03:21:59Z
<p>SnakeZero：/* 定义函数的书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<source_lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source_lang="php"><br />
<br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
=== 过长的语句要分行 ===<br />
<source_lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source_lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
<br />
=== 标准函数定义书写规范 ===<br />
函数的定义基于K&R标准。<br />
<source_lang="php"><br />
<?php<br />
function fooFunction($arg1, $arg2 = '')<br />
{<br />
if (condition) {<br />
statement;<br />
}<br />
return $val;<br />
}<br />
</source><br />
<br />
引申：<br/><br />
Brian W．Kernighan(柯尼汉)和Dennis M．Ritchie(里奇)合著了影响深远的名著《The C Programming Language》，常常称它为‘K&R’。<br />
<br />
=== 多行函数定义书写规范 ===<br />
<source_lang="php"><br />
<?php<br />
<br />
function someFunctionWithAVeryLongName($firstParameter = 'something', $secondParameter = 'booooo',<br />
$third = null, $fourthParameter = false, $fifthParameter = 123.12,<br />
$sixthParam = true<br />
) {<br />
//....<br />
}<br />
</source><br />
<br />
== 数组的书写规范 ==<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7025
Protoss/规范/代码规范
2010-08-20T03:15:48Z
<p>SnakeZero：/* 定义类的书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<source_lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source_lang="php"><br />
<br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
=== 过长的语句要分行 ===<br />
<source_lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
== 定义类的书写规范 ==<br />
类名后的大括号“{”要换行顶格书写。<br />
<source_lang="php"><br />
<?php<br />
class Foo_Bar<br />
{<br />
<br />
//... code goes here<br />
<br />
}<br />
</source><br />
{{notice|content=本节以下内容为非PEAR的书写规范，但是却是很多年经验的总结，这些经验一部分来自己我自己，另一部分也是“道上”的优秀习惯。}}<br />
类的命名使用aaa_bbb这样的方法时，应当以“_”为分割符，后段为前段包内的子项，他们是上下级关系。<br/><br />
更多更详细介绍请参考：[[Protoss/目录结构#.E5.91.BD.E5.90.8D.E8.A7.84.E8.8C.83|Protoss中的类命名规范]]。<br />
<br />
== 定义函数的书写规范 ==<br />
== 数组的书写规范 ==<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7024
Protoss/规范/代码规范
2010-08-20T03:01:15Z
<p>SnakeZero：</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
=== 上下文对齐标准 ===<br />
一般情况，我们这样对齐：<br />
<source_lang="php"><br />
<?php<br />
<br />
$short = foo($bar);<br />
$longer = foo($baz);<br />
</source><br />
当上下文的两行代码的变量名都差不多长时，应当以“=”为参照物来对齐，“=”的两边都需要有空格。<br/><br />
但是如果碰到一变量名短的变态，一个长得变态时，应该不去对齐。<br />
<source_lang="php"><br />
<br />
<?php<br />
<br />
$short = foo($bar);<br />
$thisVariableNameIsVeeeeeeeeeeryLong = foo($baz);<br />
</source><br />
=== 过长的语句要分行 ===<br />
<source_lang="php"><br />
<br />
<?php<br />
$rows[$otherrow->something]->somemethod->returnArray<br />
= $this->xajax->getJavascript(t3lib_extMgm::siteRelPath('nr_xajax'));<br />
</source><br />
== 定义类的书写规范 ==<br />
== 定义函数的书写规范 ==<br />
== 数组的书写规范 ==<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7023
Protoss/规范/代码规范
2010-08-20T02:49:59Z
<p>SnakeZero：/* 多行书写格式 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行满了的情况下才需要换行，很多时候为了增加代码的可读性，我们也用换行来书写，就像上面这段这样。还是老话，注意层级关系。<br/><br />
<br/><br />
连贯查询是个不错的东西，但是同样也会造成一条语句很长，所以我们也分行来书写，规则是在每个箭头“->”的位置换行，前面同样的是4个空格。<br />
<source lang="php"><br />
<?php<br />
<br />
$condition = array(<br />
$someModel->primaryKey => 123,<br />
'some_other_conditions_here' => 'blabla'<br />
);<br />
$someModel->select()<br />
->where($condition)<br />
->orderby('created DESC');<br />
->execute()<br />
->fetch();<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
== 定义函数的书写规范 ==<br />
== 数组的书写规范 ==<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7022
Protoss/规范/代码规范
2010-08-19T08:43:00Z
<p>SnakeZero：/* 多行书写格式 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br/><br />
好了，让我们来看一个变态点的：<br />
<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$this->someOtherFunc(<br />
$this->someEvenOtherFunc(<br />
'Help me!',<br />
array(<br />
'foo' => 'bar',<br />
'spam' => 'eggs',<br />
),<br />
23<br />
),<br />
$this->someEvenOtherFunc()<br />
),<br />
$this->wowowowowow(12)<br />
);<br />
</source><br />
并不是说一行<br />
<br />
== 定义类的书写规范 ==<br />
== 定义函数的书写规范 ==<br />
== 数组的书写规范 ==<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7021
Protoss/规范/代码规范
2010-08-18T11:04:05Z
<p>SnakeZero：</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。<br />
== 定义类的书写规范 ==<br />
== 定义函数的书写规范 ==<br />
== 数组的书写规范 ==<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7020
Protoss/规范/代码规范
2010-08-18T10:07:56Z
<p>SnakeZero：</p>
<hr />
<div>== 函数调用的书写规范 ==<br />
=== 单行调用函数 ===<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
=== 多行书写格式 ===<br />
当一行书写超过<b>80</b>个字节的时候，请分开成多行来书写，如下：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->someObject->subObject->callThisFunctionWithALongName(<br />
$parameterOne, $parameterTwo,<br />
$aVeryLongParameterThree<br />
);<br />
</source><br />
因为不是每个人都有很宽的显示器的，一般来说，如果看代码需要横向滚屏的话，会很不爽，因此需要分多行书写。为了方便阅读，一些很长的变量名(所以大蛇不建议你用很长的变量名)最好另起一行，同时几个参数写在同一行也是允许的，但是相对所属的调用函数这一级前面要加4个空格的缩进。<br/><br />
另外，要记得行末的“,”要跟着它前面的参数，且中间不能有空格。</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7019
Protoss/规范/代码规范
2010-08-18T04:04:03Z
<p>SnakeZero：/* 函数调用的书写规范 */</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
为了增加可读性，我们也可以在函数/类的方法调用时，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
$this->callSomeFunction('param1', 'second', true);<br />
$this->callSomeFunction('parameter2', 'third', false);<br />
$this->callSomeFunction('3', 'verrrrrrylong', true);<br />
</source><br />
<br />
== 定义类的书写规范 ==<br />
== 定义函数的书写规范 ==<br />
== 数组的书写规范 ==<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7018
Protoss/规范/代码规范
2010-08-18T04:00:24Z
<p>SnakeZero：</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
所有的[[http://cn.php.net/manual/en/language.operators.php 运算符(包括算术运算符、赋值运算符、位运算符、比较运算符等等)]]的左边和右边都需要有一个空格。<br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
函数调用时，函数名与“(”之间不能有空格；中间的第个参数与其之前的参数后的“,”之间要有一个空格，但是参数自己后面的“,”之间不能有空格；最后一个参数与“)”之间不能有空格。<br />
<source lang="php"><br />
<?php<br />
$var = foo($bar, $baz, $quux);<br />
</source><br />
如上面的代码所表述的，“=”的两边都需要有空格，但是如果情况特殊，上下文中都是类似的函数调用操作时，应当以“=”为参照物来对齐，如下：<br />
<source lang="php"><br />
<?php<br />
$short = foo($bar);<br />
$long_variable = foo($baz);<br />
</source><br />
== 定义类的书写规范 ==<br />
== 定义函数的书写规范 ==<br />
== 数组的书写规范 ==<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7017
Protoss/规范/代码规范
2010-08-17T12:03:46Z
<p>SnakeZero：</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
=== 条件简单时 ===<br />
<source lang="php"><br />
<?php<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
=== 条件复杂时 ===<br />
这种写法可以强调第一个条件，同时也属于中规中矩的写法。<br />
<source lang="php"><br />
<?php<br />
<br />
if (($condition1<br />
|| $condition2)<br />
&& $condition3<br />
&& $condition4<br />
) {<br />
//code here<br />
}<br />
</source><br />
下面这种写法是将多个条件对齐。好处显而易见，这样可以方便的一眼扫完所有条件，而且结构清晰。<br />
<source lang="php"><br />
<?php<br />
<br />
if ( $condition1<br />
|| $condition2<br />
|| $condition3<br />
) {<br />
//code here<br />
}<br />
</source><br />
<source lang="php"><br />
<?php<br />
<br />
$is_foo = ($condition1 || $condition2);<br />
$is_bar = ($condition3 && $condtion4);<br />
if ($is_foo && $is_bar) {<br />
// ....<br />
}<br />
</source><br />
=== 三元运算符 ===<br />
<source lang="php"><br />
<?php<br />
<br />
$a = $condition1 && $condition2<br />
? $foo : $bar;<br />
<br />
$b = $condition3 && $condition4<br />
? $foo_man_this_is_too_long_what_should_i_do<br />
: $bar;<br />
</source><br />
<br />
== 函数调用的书写规范 ==<br />
== 定义类的书写规范 ==<br />
== 定义函数的书写规范 ==<br />
== 数组的书写规范 ==<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero
http://wiki.blueidea.com/index.php?title=Protoss/%E8%A7%84%E8%8C%83/%E4%BB%A3%E7%A0%81%E8%A7%84%E8%8C%83&diff=7016
Protoss/规范/代码规范
2010-08-17T07:51:58Z
<p>SnakeZero：</p>
<hr />
<div>写在前面：<br />
本规则基于PEAR的代码书写规范，但是又有些许改进，在不同的地方会指出。<br/><br />
== 缩进规则与行书写规范 ==<br />
所有代码中，均使用4个空格作为缩进标准，不允许使用制表符(tab)。<br/><br />
这样做的好处是：不管什么系统或者编辑器下看，代码都是整齐的。在使用SVN、CVS等工具或者查看diff时，不会对编码和阅读人员带来困难。<br/><br />
<br/><br />
如果你使用的是的Emacs编辑器，请设置“indent-tabs-mode”。<br/><br />
如果你使用的是大蛇所钟爱的Vim(GVim)的话，请在_vimrc中作如下设置：<br/><br />
set expandtab<br/><br />
set shiftwidth=4<br/><br />
set softtabstop=4<br/><br />
set tabstop=4<br/><br />
<br/><br />
== 控制结构书写规范 ==<br />
Control Structures，多译作控制结构，可以参考[[http://cn.php.net/manual/en/language.control-structures.php PHP手册]]。<br/><br />
其实说白了就是if, for, while, switch这些啦。<br/><br />
一般不是很复杂的条件判断写成这样：<br />
<source lang="php"><br />
<?php<br />
if ((condition1) || (condition2)) {<br />
action1;<br />
} elseif ((condition3) && (condition4)) {<br />
action2;<br />
} else {<br />
defaultaction;<br />
}<br />
</source><br />
注意上面这段代码中，if与“(”之间有个空格，两个条件与符号间有空格。“)”与“{”之间有空格，<b>并且是在同一行</b>。<br/><br />
else和elseif的前后大括号“}”和“{”都在同一行。<br/><br />
<br/><br />
如果是switch的话，写成这样：<br />
<source lang="php"><br />
<?php<br />
switch (condition) {<br />
case 1:<br />
action1;<br />
break;<br />
<br />
case 2:<br />
action2;<br />
break;<br />
<br />
default:<br />
defaultaction;<br />
break;<br />
}<br />
</source><br />
注意case和switch的缩进级别是一致的。<br/><br />
<br />
== 函数调用的书写规范 ==<br />
== 定义类的书写规范 ==<br />
== 定义函数的书写规范 ==<br />
== 数组的书写规范 ==<br />
== 注释的书写规范 ==<br />
== 载入文件的书写规范 ==<br />
== 文件头部注释书写规范 ==<br />
== 文件的相关规范 ==</div>
SnakeZero