如何为PHP项目创建自动代码文档？

问题描述

我有一个大项目，使用CakePHP。现在我想为其他新同事创建一个文档。

一个想法是使用现有的PHPdoc注释和代码中的其他注释来创建自动文档

1. 如何管理这样一个大项目，以及如何创建一个可浏览的HTML文档？ p>




2. 如何自动添加缺少的评论？
   
   （我使用Eclipse进行编码，但如果更容易在另一个编辑器中我不介意。）
   
   有很多函数声明如下：

   
   
   

   ＃一些解释不在phpDoc

函数whatever（）{

... 。

}

b $ b

如果我可以使用外部编辑器只编辑phpdoc注释，并且它们被自动插入源代码中的正确位置，这将是最佳的。

解决方案

您可以使用 ApiGenerator 插件。它是一个Cake插件，它使用与PhpDocumentor相同的语法，并生成您只需要运行一个shell命令的文档。

I have a big project, that uses CakePHP. Now I would like to create a documentation for other new co-workers.

An idea was to use the existing PHPdoc comments and other comments inside the code to create an automatic documentation for a start.

1. How can I manage such a big project and How would I create a browsable HTML-Documentation?

2. How can I automatically add missing comments?
   (I use Eclipse for coding, but if it is easier in another editor I wouldn't mind.)
   There are many functions declared like this:

   # some explanation not in phpDoc
function whatever() {
....
}

It would be optimal if I could use an external Editor to edit only the phpdoc comments and they were automatically inserted in the sourcecode at the right positions.

解决方案

You can use ApiGenerator plugin. It's a Cake plugin that uses the same syntax as PhpDocumentor, and for generate the document you just have to run a shell command.

https://github.com/cakephp/api_generator

这篇关于如何为PHP项目创建自动代码文档？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持！