这几天我正在做几个CakePhp项目,我想知道我应该如何记录它们.我在轨道上使用ruby,在框架的帮助下轻松记录文档.
CakePhp中有这样的东西吗？我正在查看框架的文档,但我找不到任何相关内容.如果它不是框架的一部分,那么记录我的项目的正确方法是什么？
您应该尝试用于为官方CakePHP API提供动力的Api Generator插件(此处介绍).
它使用Reflection类(在PHP 5.2及更高版本中提供)动态地内省代码的docblock注释,这意味着您不必为每个更改重新生成文档.
还有一些额外的功能,例如搜索索引,计算代码的文档覆盖率,以及允许在docblock注释中使用Markdown在文档中生成HTML.
您总是可以使用适用于任何PHP代码库的通用解决方案,例如phpDocumentor或doxygen.
您需要使用适当的标记将docblock添加到您的代码中,以使这些解决方案能够正常工作(某些IDE可以为您生成这些解决方案).所述芯CakePHP的代码 (和相关联的文档)可以被用作需要什么的一个很好的例子.
我注意到CakePHP团队在记录代码时使用了一些微妙的标准: