You are here

Drupal专业开发指南 第21章 PHP注释

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,你就可以看到这个模块的一个实例,而关于API模块的更多信息,可参看http://drupal.org/project/api
老葛的Drupal培训班 Think in Drupal
 

Drupal版本: