Drupal 代码规范有哪些?

戴文Drupal说 发布于 2016/08/26 10:38
阅读 302
收藏 1

原文地址:https://chromatichq.com/blog/drupal-code-standards-what-are-they

什么是Drupal代码规范??

代码规范规定了编写代码的最佳实践,代码的格式,和其它等一系列的规则。你可以认为它是编程里的MLA。 它告诉我们如何书写我们的代码,每个人都遵循同样的规范。

Style

代码规范主要是关注你的代码显示和易读性上,它告诉你用怎样风格和怎么排版你的代码,其中包括代码的缩近,空白,代码行的长度。 保证你的所有代码都遵循一定规则让整个drupal项目保持协调一致,保证一个开发者能很方便阅读其它开发者的代码。

Substance

代码规范也能描述出代码包含的内容和代码的目的。 包括对函数和代码组件的描述,比如,确保你使用在某一情景下使用翻译函数,或者, 当有两个相近的函数时应指出什么情况用哪一个: Sizeof() 和 count() 有同样的功能,那怎么才知道要用哪一个呢? 代码规范能指出你应该用哪个,怎么用,期望得到什么。

保证代码的易读性

当我们都遵循着相同的代码规范, 你和你的合作伙伴的代码都能以相同的方式来阅读。你们可以相互阅读对方的代码并且知道期望得到什么。 如果你发布了一个模块,来自世界另一端的朋友可以轻松的修改、维护你的代码, 在Drupal社区这是必需的。

不必把时间花费在你的代码看起来怎样, 更多的时间在写代码本身

当写这篇文章时,我看到很多关于有没有必要遵循和是不是要严苛的执行代码规范的相关讨论。我想Drupal社区也用了大量的时间来决定Drupal代码规范,幸运的是一切已经完成了。Drupal代码规范已经建立好了,我们不用在上面再花费时间了。

为不同地区,不同语言,不同背景的开发者之间架起一座桥梁

Drupal 代码书写规范基于英语,当下与来自世界各地的朋友合作开发一个项目变的越来越普遍, 有一个标准能降低沟通成本。 加入Drupal的开发者们之前都有着不同的编程语言开发背景,每种编程语言都有自己的语法和书写格式。 有一个具体的代码书写规范才能使我们的项目代码持续前进。

自动化

代码规范在文档自己动化中也非常重要,因为API模块会自动解析代码文件中的信息来生成文档,http://api.drupal.org 的文档内容就来于此, 你甚至可以配置出一个属于自己的API文档网站,文档内容是通过识别和解析代码注释中的一些特殊标签和标签后面的具体文字信息来生成的。如果你写的代码遵循标准,你可以通过PHP_Codesniffer来检查是否符合标准,甚至可以配合 Travis CI来自动化的更准确的校验代码是否规范。 代码越整洁,工作量就越少!

谁来定制代码规范?又是如果定制的?

我们自己来做的! 代码规范由社区来确定的。Drupal代码规范是在PEAR的代码规范为基础设计的。 不仅如此, 也由drupal.org网站的相关问题列表来决定。 如果某人提出一个问题, 提供一个解决方案, 大家一起讨论,当大家达成一致时,一个新的规范就诞生了。

如果你之前不能确定什么是代码规范和他的意义所在,我希望这篇文章能让你理解它的目的和用途。 我们的下一篇文章将带你在项目中实施Drupal代码规范。

加载中
0
宏哥
宏哥

是一个

“烂” 

规范

返回顶部
顶部