如何使用 PHPdoc 记录数据库使用情况？

Question

现在我想知道其他人是否在函数头中记录数据库的使用情况...例如， fn() 可能会读取或写入数据库（或其表），或者创建、修改或删除数据库或表。 （附带问题：使用“USE xxx”更改数据库的 fn() 应该“记住”进入时的当前数据库并在退出之前再次使用它吗？）

在我看来，这种事情应该 被记录下来，但是如何最好地做到这一点呢？ @uses，还是什么？

Answer 1

为什么不使用 @link 和一个列表，以及帮助器列表：

/**
 * Some comments here.
 *
 * Helper functions:
 * * {@link someHelper}
 * * {@link theOtherHelper}
 *
 * Reads tables:
 * * {@link Table1}
 * * {@link Table2}
 *
 * Reads/Writes tables:
 * * {@link Table3}
 * * {@link Table4}
 */

然后，您为这些表创建一些主题页面，只有一个简短的描述，“保存业务流程 X 的参数”。