如何在ApiGen中使用<code>

Question

使用ApiGen自动生成文档。添加后续注释以生成文档。我曾希望“代码”中代码块会出现与short描述中相同的外观，但它不起作用。我不知道怎么做同样的东西。有什么方法吗？

​

/**
 * Short desc
 * 
 * @param array $tabs
 * 
 * For example
 * <code>
 * $admin_tabs = array(
 *           'AdminDeliveryManager' => array('name' => 'Delivery manager', 'id_parent' => 0),
 *           'AdminRole' => array('name' => 'Admin role', 'id_parent' => -1),
 *           'AdminEmployeeRole' => array('name' => 'Admin role', 'id_parent' => -1)
 *       );
 * </code>
 * 
 * @return boolean true if all tabs created / false if have some error
 */

Answer 1

ApiGen希望简单的描述首先出现，然后是所有的标记行。

如何使用该函数的示例应该放在一个@example标记中，如下所示：

/**
 * Short desc
 *
 * @param  array   $tabs
 * @return boolean       true if all tabs created / false if have some error
 * @example
 * <code>
 * $admin_tabs = array(
 *           'AdminDeliveryManager' => array('name' => 'Delivery manager', 'id_parent' => 0),
 *           'AdminRole' => array('name' => 'Admin role', 'id_parent' => -1),
 *           'AdminEmployeeRole' => array('name' => 'Admin role', 'id_parent' => -1)
 *       );
 * createTabs($admin_tabs);
 * </code>
 */

​

​