如何制定一份编码规范

简介: 以前整理出来并在团队中推行的一份PHP编码规范,纸质的还在,电子版的居然找不到了,只好重新再整理一份。整理的过程中,忽然想到,这样的规范每个团队都不同,放在这里的意义不大,所以转而整理规范制定的思路。在PHP的内部世界,一时骆驼峰、一时小写下划线,整个命名本身就是一个很混乱的状态。

以前整理出来并在团队中推行的一份PHP编码规范,纸质的还在,电子版的居然找不到了,只好重新再整理一份。整理的过程中,忽然想到,这样的规范每个团队都不同,放在这里的意义不大,所以转而整理规范制定的思路。

在PHP的内部世界,一时骆驼峰、一时小写下划线,整个命名本身就是一个很混乱的状态。后来,PHP的官方团队逐渐整理出叫PEAR及Zend的编码规范,PEAR同时也是一套类似PERL语言中CPAN的代码仓库。有规范比没有规范好,但PEAR的核心特征包括Zend编码规范 - 类名形如 PEAR_Exception这样的写法,看似c式与骆驼峰式的结合体,但从书写繁琐程度来看,无疑是不太合理的。一般我们讨厌一个人或某个事物,往往只是一个原因就够了。

上面讲的是编码规范对代码书写便利程度的考量,接下来就是命名了。

引用DoitPHP框架编码规范中说的:

命名是程序规划的核心。古人相信只要知道一个人真正的名字就会获得凌驾于那个人之上的不可思议的力量。只要你给事物想到正确的名字,就会给你以及后来的人带来比代码更强的力量。 
名字就是事物在它所处的生态环境中一个长久而深远的结果。总的来说,只有了解系统的程序员才能为系统取出最合适的名字。如果所有的命名都与其自然相适合,则关系清晰,含义可以推导得出,一般人的推想也能在意料之中。

命名不仅仅是为了让代码有更好的可读性,首先更是体现了编程人员对一个事物的认识程度。读过形形色色的代码,就会发现,写得好的代码就像一篇优美的文章,首要是语义准确、文法流畅;而写得没那么好的代码,则晦涩难懂。

已经有了编码规范概念的同学基本无需再看,可以往几个相关名词PEAR、phpDocumentor、CodeSniffer延伸关注即可。

以前参照的是网上流传的是清华BBS一篇2000年左右的帖子,现在在网上也是找不到了。本文主要内容来源于网络,经过作者自己实际经验整理改写。

目录
相关文章
|
8月前
|
安全 项目管理
一文搞懂需求流程规范的制定方法和落地技巧
随着业务和产品的发展、团队的不断扩大,很多团队都不可避免的会遇到需求流程混乱的问题。虽然有的团队也编写了一些“需求流程规范”的文档,但最终却流于纸面,难以在团队真正落地。如何科学制定并有效落实需求管理规范呢?对此,云效产品经理陈逊进行了非常详细的直播分享,本文是他经验的文字总结。
102549 19
|
测试技术 数据安全/隐私保护
软件测试制度-新手小白如何制定测试管理工作规范?
软件测试制度-新手小白如何制定测试管理工作规范?
332 1
|
8月前
|
自然语言处理 安全 Java
【软件测试】教你如何写一份软件测试报告
【软件测试】教你如何写一份软件测试报告
|
6月前
|
设计模式 程序员
代码可读性问题之培养和提高团队对代码可读性的重视,如何解决
代码可读性问题之培养和提高团队对代码可读性的重视,如何解决
|
8月前
|
运维 监控 安全
如何制定科学有效的需求流程规范话题浅谈
【1月更文挑战第1天】如何制定科学有效的需求流程规范话题浅谈
|
8月前
|
监控 算法 安全
缺陷管理不规范,咋办
缺陷管理不规范,咋办
118 0
|
项目管理
【项目开发计划制定工作经验之谈】
【项目开发计划制定工作经验之谈】
133 1
|
敏捷开发 人工智能 自然语言处理
测试思想-文档评审 需求分析和评审简述
测试思想-文档评审 需求分析和评审简述
126 0
|
数据采集 机器学习/深度学习 存储
谈谈数据标准如何制定
数据标准是打破数据孤岛和创建互操作性或在不同系统和组织之间交换数据的能力的关键。
谈谈数据标准如何制定
|
BI 程序员
实施项目--为什么开发人员一直在抱怨需求变动
  几年前的某个时候,公司大伙都等着下班我却等着晚上加班,因为产品经理对产品的某个功能进行了调整和修改,我必须加班将其修改完善。对于这种事情我已经数不清了,产品经理的每一次变动都得让我们技术部门的同学们加班到深夜甚至到天明,如今回忆起来历历在目!今天这个文章我们不谈论是谁的责任,也不去抨击产品经理的无能,说说技术人员为什么总是在抱怨需求在变动这些事, 希望大家踊跃讨论。
1278 0

相关实验场景

更多