记录CakePHP组件

Question

我最关心的是记录控制器的操作，例如http://foo.bar/app/thing/action/param。你会如何推荐记录这些？我对生成文档的方法（例如phpdoc或doxygen）不太感兴趣，更多的是这样做的风格。我应该列出参数并返回值，就好像我正在记录任何其他方法一样？

Answer 1

就格式而言，我通常遵循CakePHP项目本身（http://book.cakephp.org/view/509/Coding-Standards#Commenting-code-601）使用的相同（很好，相似）约定。它与JavaDoc非常相似，我发现很容易采用并且很好地与phpDoc引擎配合使用。我倾向于包括@param值以及@return。我经常发现为可接受/预期值提供一些额外解释是有帮助的。