16 为常量编写文档
作者:老葛,北京亚艾元软件有限责任公司,http://www.yaiyuan.com
PHP常量应该大写,可以使用下划线分隔单词。当定义PHP常量时,最好能够解释一下它们是用来做什么的,如下面的代码片段所展示的这样:
作者:老葛,北京亚艾元软件有限责任公司,http://www.yaiyuan.com
PHP常量应该大写,可以使用下划线分隔单词。当定义PHP常量时,最好能够解释一下它们是用来做什么的,如下面的代码片段所展示的这样:
作者:老葛,北京亚艾元软件有限责任公司,http://www.yaiyuan.com
我们以node.module文件为例,来学习一下模块文档的编写。我们按照从上到下的顺序,对不同的类型的文档做出对应的解释。
在模块的第3行(在
作者:老葛,北京亚艾元软件有限责任公司,http://www.yaiyuan.com
Drupal实现了大多数的Doxygen注释规范。所有的文档必须使用下面的语法:
作者:老葛,北京亚艾元软件有限责任公司,http://www.yaiyuan.com
在你自己的模块中,最好不要定义全局变量。当然我们可以使用Drupal自带的全局变量,比如$user, $language.比如(摘自node.module中的node_object_prepare函数)
global $user;
作者:老葛,北京亚艾元软件有限责任公司,http://www.yaiyuan.com
作者:老葛,北京亚艾元软件有限责任公司,http://www.yaiyuan.com
在点号两边分别使用空格:
作者:老葛,北京亚艾元软件有限责任公司,http://www.yaiyuan.com
对于数组,也是使用空格对它的每个元素和每个赋值操作符进行分隔的。如果数组区块跨越了80个字符,那么每个元素都应独立成行。为了提高可读性和可维护性,最好将每个元素全部独立成行。这样你就可以方便的添加、删除数组元素。
作者:老葛,北京亚艾元软件有限责任公司,http://www.yaiyuan.com
在Drupal中,函数的名字都是小写的,为了避免命名空间冲突,通常以模块的名字或者它们所属系统的名字作为前缀。下划线用来分隔函数名字的描述性部分。在模块名的后面,通常应该紧跟一个动词,接着是动词作用的对象:modulename_verb_object()。在下面的第一个例子中,函数名字没有正确的使用模块前缀,并且动词和它的对象颠倒了。在接下来的例子中,很明显,修正了这些错误。