我正在写一个小自制ORM(学术兴趣).我正在努力坚持TDD概念作为培训练习,作为练习的一部分,我正在编写API的文档,因为我开发了类.
举个例子 - 我正在研究经典的"getCollection"类型映射器类.我希望它能够为特定用户检索资产X的集合(比如博客文章),以及基于任意数值的数组的集合.所以 - 你可能有一个类似于其中任何一个的方法
$User = $UserMapper->load(1);
$ArticleCollection = $ArticleMapper->getCollection(range(10,20));
$ArticleCollection = $ArticleMapper->getCollection($User);
$ArticleCollection = $ArticleMapper->getCollection($User->getId());
Run Code Online (Sandbox Code Playgroud)
因此,在编写getCollection方法的文档时 - 我想在Docblock中声明@param变量.为每个参数类型设置一个唯一的方法是否更好,或者是否可以根据参数类型委托给正确的内部方法/类?