记录CakePHP组件
记录CakePHP组件
提问于 2009-08-19 17:08:34
我最关心的是记录控制器的操作，例如http://foo.bar/app/thing/action/param。您建议如何记录这些内容？我对生成文档的方法(例如phpdoc或doxygen)不太感兴趣，而更感兴趣的是一种方式。我是否应该像记录任何其他方法一样列出参数和返回值？
回答 1
Stack Overflow用户
发布于 2009-08-20 01:48:55
在格式方面，我通常遵循与CakePHP项目本身(http://book.cakephp.org/view/509/Coding-Standards#Commenting-code-601)相同(好吧，类似)的约定。它与JavaDoc非常相似，我发现它很容易采用，并且可以很好地与phpDoc引擎配合使用。我确实倾向于包含返回值以及@ @param。我经常发现为可接受/期望值提供一点额外的解释是有帮助的。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/1301318
复制相关文章
相似问题
腾讯云开发者
