14 PHP注释

作者:老葛,北京亚艾元软件有限责任公司,http://www.yaiyuan.com

Drupal实现了大多数的Doxygen注释规范。所有的文档必须使用下面的语法:

 

/**

 * Documentation here.

 */

 

除了第一行以外,其它各行在星号(*)前面必须要有一个空格。

 

注意 Doxygen是一个能够友好支持PHP的文档生成器。它从代码中提取PHP注释并生成适合用户阅读的文档。更多信息,可参看http://www.doxygen.org

 

当为一个函数添加说明文档时,对应文档必须紧挨着放在函数前,中间不能存在空行。

 

Drupal能够理解下面所列的Doxygen结构;我们接下来会对其中的大多数作简单的介绍,不过有关它们的更多信息,请参看Doxygen的官方站点。

 

• @mainpage

• @file

• @defgroup

• @ingroup

• @addtogroup (as a synonym of @ingroup)

• @param

• @return

• @link

• @see

• @{

• @}

 

遵循这些标准的好处是,你可以使用第3方的API模块,为你的模块自动生成文档。API模块实现了Doxygen文档生成器规范的一个子集,并专门针对Drupal代码的文档生成进行了优化。访问http://api.drupal.org,你就可以看到这个模块的一个实例,除了官方的这个站点以外,还有http://drupalcontrib.org/,里面包含了常用第三方模块的文档。而关于API模块的更多信息,可参看http://drupal.org/project/api


Drupal版本: