Drupal遵循大多数的Doxygen注释样式指南。所有的文档区块必须使用下面的语法:
/**
* Documentation here.
*/
除了第一行以外,其它各行在星号(*)前面必须要有一个空格。
当为一个函数添加说明文档时,文档区块必须紧挨着放在函数前,中间不能存在空行。
Drupal能够理解下面所列的Doxygen构造体;尽管我们接下来会介绍到其中的大多数,不过关于如何使用它们的更多信息,请参看Doxygen的官方站点。
• @mainpage
• @file
• @defgroup
• @ingroup
• @addtogroup (as a synonym of @ingroup)
• @param
• @return
• @link
• @see
• @{
• @}