作者:老葛,北京亚艾元软件有限责任公司,http://www.yaiyuan.com
我们以node.module文件为例,来学习一下模块文档的编写。我们按照从上到下的顺序,对不同的类型的文档做出对应的解释。
在模块的第3行(在<?php开始标签下面),包含了一段文档,它用来介绍这个模块是做什么的。文档的内容如下所示:
/**
* @file
* The core that allows content to be submitted to the site. Modules and
* scripts may programmatically submit nodes using the usual form API pattern.
*/
上面的意思是说,这个模块是用来向站点提交内容的。通过使用表单API的方式,第三方模块也可以通过程序的方式提交节点。
在node.pages.in文件的开头,也存在类似的文档:
/**
* @file
* Page callbacks for adding, editing, deleting, and revisions management for content.
*/
上面的意思是说,node.pages.in文件,里面包含了各种页面回调函数,比如节点添加、编辑、删除,以及修订本管理对应的页面。
通过上面的两个例子可以看出,@file指令就是对当前文件的用途做出说明。