記錄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。我經常發現爲可接受/預期值提供一些額外解釋是有幫助的。