如何使用PHPdoc记录数据库使用情况?
问题描述:
现在我想知道如果其他人记录函数头中的数据库使用情况...例如,fn()可能读取或写入数据库(或其表),或者创建,修改或删除数据库或表。 (侧面的问题:应该使用“USE xxx”修改数据库的fn()'记住'当前数据库的入口并在退出前再次使用它?)如何使用PHPdoc记录数据库使用情况?
在我看来,这种事情应该记录,但如何最好地这样做? @uses
,还是什么?
答
为什么不使用@link和一个列表,与助手的名单一起:
/**
* Some comments here.
*
* Helper functions:
* * {@link someHelper}
* * {@link theOtherHelper}
*
* Reads tables:
* * {@link Table1}
* * {@link Table2}
*
* Reads/Writes tables:
* * {@link Table3}
* * {@link Table4}
*/
然后你做这些表的一些话题页,只是一个简短的描述,“认为业务流程X参数“。