php - Doxygen 忽略 @method

Question

我有一些神奇的方法，但在 netbeans 中仍然具有自动完成功能。我在所有类之上使用一个块，如：

/**
 * @method int getEavConfigId() get object id
 * @method Model_DbTable_EavConfig setEntityType(string $entity_type) set entity_type possible values site, user, pc, ticket, alarm ; eav field is realted to this table
 * @method string getEntityType() get entity_type possible values site, user, pc, ticket, alarm ; eav field is realted to this table
 * @method Model_DbTable_EavConfig setCompanyId(integer $company_id) set company_id
 * @method integer getCompanyId() get company_id
 * @method Model_DbTable_EavConfig setType(string $type) set type possible values textfield, textarea, radio, checkbox, select ; eav field type
 * @method string getType() get type possible values textfield, textarea, radio, checkbox, select ; eav field type
 */

对于netbeans，这很好用。但是 doxygen 接缝完全忽略了它。

有人知道是否可以让 doxygen 接受 @method 标签？

我知道 phpDocumentator 可以处理这个问题。但我不喜欢 doxygen 的文档，原因有几个。

Answer 1

Doxygen 已经实现了您的问题解决方案，它被称为 ALIASES。别名的定义应该在配置文件中使用 ALIASES 配置标签来指定。

简单别名

别名的最简单形式是形式的简单替换

name=value

例如定义以下别名：

ALIASES += sideeffect="\par Side Effects:\n" 

将允许您将命令 \sideeffect（或@sideeffect）放入文档中，这将导致用户定义的段落带有标题 Side Effects:。

请注意，您可以将 \n 放在别名的值部分中以插入换行符。

另请注意，您可以根据需要重新定义现有的特殊命令。

一些命令，例如 \xrefitem 被设计为与别名结合使用。

希望这能解决您的问题，更多信息请访问doxygen