blocks|key|5622409|text|ApiGen|type|unstyled|depth|inlineStyleRanges|entityRanges|data|5622410|http://apigen.org/|offset|length|5622411|ApiGen支持PHP5.3命名空间、包、文档之间的链接、对PHP标准类和通用文档的交叉引用、突出显示的源代码的创建以及对PHP5.4特性的实验支持。|5622412|DocBlox|5622413|http://www.docblox-project.org/|5622414|PHP+5.3兼容API文档生成器，适用于各种规模的项目和持续集成。|5622415|能够完全解析和转换Zend+Framework2|5622416|entityMap|0|LINK|mutability|MUTABLE|url|1^0|0|0|I|0|0|0|0|0|V|1|0|0|0^^$0|@$1|2|3|4|5|6|7|X|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|Y|8|@]|9|@$D|Z|E|10|1|11]]|A|$]]|$1|F|3|G|5|6|7|12|8|@]|9|@]|A|$]]|$1|H|3|I|5|6|7|13|8|@]|9|@]|A|$]]|$1|J|3|K|5|6|7|14|8|@]|9|@$D|15|E|16|1|17]]|A|$]]|$1|L|3|M|5|6|7|18|8|@]|9|@]|A|$]]|$1|N|3|O|5|6|7|19|8|@]|9|@]|A|$]]|$1|P|3|-4|5|6|7|1A|8|@]|9|@]|A|$]]]|Q|$R|$5|S|T|U|A|$V|C]]|W|$5|S|T|U|A|$V|K]]]]

<h2>ApiGen</h2>

<a href="http://apigen.org/">http://apigen.org/</a>

ApiGen has support for PHP 5.3 namespaces, packages, linking between documentation, cross referencing to PHP standard classes and general documentation, creation of highlighted source code and experimental support for PHP 5.4 traits.

<h2>DocBlox</h2>

<a href="http://www.docblox-project.org/">http://www.docblox-project.org/</a>

PHP 5.3 compatible API Documentation generator aimed at projects of all sizes and Continuous Integration.

able to fully parse and transform Zend Framework 2

blocks|key|5622284|text|有两个众所周知且经常使用的工具可以从docblock生成API文档：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|5622285|5622286|phpDocumentor，是专门针对PHP的，可能是用于PHP项目和|unordered-list-item|offset|length|5622287|和Doxygen的最常用的工具之一，它更多地用于C语言，但也被一些人用于PHP。|5622288|5622289|关于“指导方针”：我会说这取决于你的项目，但至少，我希望看到：|5622290|带有@param+type+name+description+of+the+parameter|style|CODE|5622291|return值的方法/函数does|5622292|
|5622293|parameters，|5622294|5622295|，带有@throws+type+description+of+the+exception+that+can+be+thrown|5622296|
的|5622297|的描述|5622298|5622299|最新的集成开发环境(例如+)可以读取和解释这些标记，以便在编写代码时提供提示;-)|5622300|此外，越来越多的PHP工具将php文档块用于文档以外的其他目的。|5622301|例如，PHPUnit允许您使用一些特定的标记指定一些与测试相关的内容--请参阅Annotations。|5622302|entityMap|0|LINK|mutability|MUTABLE|url|http://www.phpdoc.org/|1|http://www.doxygen.nl/|2|http://www.phpunit.de/manual/3.4/en/appendixes.annotations.html^0|0|0|0|D|0|0|1|7|1|0|0|0|2|19|0|0|0|0|0|3|1O|0|0|0|0|0|0|13|B|2|0^^$0|@$1|2|3|4|5|6|7|1M|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|1N|8|@]|9|@]|A|$]]|$1|C|3|D|5|E|7|1O|8|@]|9|@$F|1P|G|1Q|1|1R]]|A|$]]|$1|H|3|I|5|E|7|1S|8|@]|9|@$F|1T|G|1U|1|1V]]|A|$]]|$1|J|3|-4|5|6|7|1W|8|@]|9|@]|A|$]]|$1|K|3|L|5|6|7|1X|8|@]|9|@]|A|$]]|$1|M|3|N|5|6|7|1Y|8|@$F|1Z|G|20|O|P]]|9|@]|A|$]]|$1|Q|3|R|5|E|7|21|8|@]|9|@]|A|$]]|$1|S|3|T|5|6|7|22|8|@]|9|@]|A|$]]|$1|U|3|V|5|E|7|23|8|@]|9|@]|A|$]]|$1|W|3|T|5|6|7|24|8|@]|9|@]|A|$]]|$1|X|3|Y|5|E|7|25|8|@$F|26|G|27|O|P]]|9|@]|A|$]]|$1|Z|3|10|5|6|7|28|8|@]|9|@]|A|$]]|$1|11|3|12|5|E|7|29|8|@]|9|@]|A|$]]|$1|13|3|-4|5|6|7|2A|8|@]|9|@]|A|$]]|$1|14|3|15|5|6|7|2B|8|@]|9|@]|A|$]]|$1|16|3|17|5|6|7|2C|8|@]|9|@]|A|$]]|$1|18|3|19|5|6|7|2D|8|@]|9|@$F|2E|G|2F|1|2G]]|A|$]]|$1|1A|3|-4|5|6|7|2H|8|@]|9|@]|A|$]]]|1B|$1C|$5|1D|1E|1F|A|$1G|1H]]|1I|$5|1D|1E|1F|A|$1G|1J]]|1K|$5|1D|1E|1F|A|$1G|1L]]]]

There are two well-known and often-used tool that can generate API doc from docblocks : 

<ul>
<li><a href="http://www.phpdoc.org/" rel="nofollow noreferrer">phpDocumentor</a>, which is specific to PHP, and is probably one of the most used tool for PHP projects</li>
<li>and <a href="http://www.doxygen.nl/" rel="nofollow noreferrer">Doxygen</a>, which is more for C, but is used for PHP by some people.</li>
</ul>

 
About the "guidelines" : I would say it depends on your projects, but, at least, I would expect to see :

<ul>
<li>a description of what the method/function does</li>
<li>parameters, with <code>@param type name description of the parameter</code></li>
<li>return value, with <code>@return type description of the return value</code></li>
<li>exceptions, with <code>@throws type description of the exception that can be thrown</code></li>
</ul>

A great thing being that recent IDE (like <a href="http://eclipse.org/pdt/" rel="nofollow noreferrer">Eclipse PDT</a>, for instance), can read and interpret those markers, to provide hints when you're coding ;-)

 
Also, there are more and more PHP tools that use php docblocks for some other purpose than documentation.

For instance, PHPUnit allows you to specify some test-related stuff using some specific tags -- see <a href="http://www.phpunit.de/manual/3.4/en/appendixes.annotations.html" rel="nofollow noreferrer">Annotations</a>.

blocks|key|1667062|text|就Javadoc风格的内联注释而言，PHPDoc可能是最好的。您可能还想看看PHPXRef。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|1667063|entityMap|0|LINK|mutability|MUTABLE|url|http://phpxref.sourceforge.net/^0|12|7|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

PHPDoc is probably as good as you'll get it in terms of Javadoc style inline commenting. You might also want to look at <a href="http://phpxref.sourceforge.net/" rel="noreferrer">PHPXRef</a>.

blocks|key|2093746|text|是的，phpDocumentor+(http://www.phpdoc.org/)是一个可以接受的标准PHP工具。它是事实上的标准。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|2093747|在编写JavaDoc代码文档时，遵循一般的PHP代码指南是可以接受的。但是，您将遇到这样做不够的情况，因为PHP和Java是不同的语言。|2093748|例如，PHP函数没有返回类型，函数在一个上下文中返回一个类型，在第二个上下文中返回另一个类型是不可避免的(有时也是可取的)。JavaDoc的指导方针对此没有帮助，因为这在Java语言中是不可能做到的。|2093749|entityMap|0|LINK|mutability|MUTABLE|url|http://www.phpdoc.org/^0|I|M|0|0|0|0^^$0|@$1|2|3|4|5|6|7|P|8|@]|9|@$A|Q|B|R|1|S]]|C|$]]|$1|D|3|E|5|6|7|T|8|@]|9|@]|C|$]]|$1|F|3|G|5|6|7|U|8|@]|9|@]|C|$]]|$1|H|3|-4|5|6|7|V|8|@]|9|@]|C|$]]]|I|$J|$5|K|L|M|C|$N|O]]]]

Yes, phpDocumentor (<a href="http://www.phpdoc.org/" rel="noreferrer">http://www.phpdoc.org/</a>) is an acceptable standard tool for PHP autodocs. It's the de-facto standard.

It's acceptable to follow the general JavaDoc guidelines for code when documenting PHP code. However, you're going to run into cases where that's not enough because PHP and Java are different languages. 

For example, PHP functions have no return type and it's inevitable (and sometimes desirable) for a function to return one type with one context, and another type with in a second context. JavaDoc guidelines aren't going to help with that, because it's impossible to do in Java.

blocks|key|2093570|text|phpDocumentor可以以类似于php.net文档的风格输出(它内置了smarty和non+smarty布局)|type|unstyled|depth|inlineStyleRanges|entityRanges|data|2093571|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

phpDocumentor can output in a style similar to the php.net documentation (and its built in with both smarty and non smarty layouts)

blocks|key|1667089|text|查看Javadoc+http://peej.github.com/phpdoctor/，这是一个简单但功能齐全的PHPDoctor克隆。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|1667090|entityMap|0|LINK|mutability|MUTABLE|url|http://peej.github.com/phpdoctor/^0|A|X|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

Check out PHPDoctor <a href="http://peej.github.com/phpdoctor/" rel="nofollow">http://peej.github.com/phpdoctor/</a>, a simple yet full features Javadoc clone for PHP.

blocks|key|4204511|text|Wordpress的代码库是使用phpdoc标签编写的(参见this)，而且它通常相当不错-它是使用phpDocumentor呈现的here。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|4204512|我编写的大部分代码都是在.Net中完成的，所以我不能从文档作者的角度给出太多的观点|4204513|entityMap|0|LINK|mutability|MUTABLE|url|http://codex.wordpress.org/Inline_Documentation|1|http://www.phpdoc.org/|2|http://phpdoc.wordpress.org/trunk/^0|U|4|0|1E|D|1|1U|4|2|0|0^^$0|@$1|2|3|4|5|6|7|R|8|@]|9|@$A|S|B|T|1|U]|$A|V|B|W|1|X]|$A|Y|B|Z|1|10]]|C|$]]|$1|D|3|E|5|6|7|11|8|@]|9|@]|C|$]]|$1|F|3|-4|5|6|7|12|8|@]|9|@]|C|$]]]|G|$H|$5|I|J|K|C|$L|M]]|N|$5|I|J|K|C|$L|O]]|P|$5|I|J|K|C|$L|Q]]]]

The Wordpress code-base is documented using phpdoc tags (see <a href="http://codex.wordpress.org/Inline_Documentation" rel="nofollow noreferrer">this</a>) and it's generally pretty good - it's rendered <a href="http://phpdoc.wordpress.org/trunk/" rel="nofollow noreferrer">here</a> using <a href="http://www.phpdoc.org/" rel="nofollow noreferrer">phpDocumentor</a>. 

Most of the code that I write that's substantial enough that I need to think about autogenerating docs for is done in .Net, so I can't give much of a documentation writer's perspective though

blocks|key|4204345|text|如果丑陋是个问题，我会把样式表换成自定义的。如果你不想覆盖生成的插件，你可以使用像Stylish这样的火狐插件。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|4204346|entityMap|0|LINK|mutability|MUTABLE|url|https://addons.mozilla.org/en-US/firefox/addon/2108^0|15|7|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

If ugly's a problem, I'd just switch the stylesheet for a custom one. If you don't want to overwrite the generated one, you can use a Firefox plugin like <a href="https://addons.mozilla.org/en-US/firefox/addon/2108" rel="nofollow noreferrer">Stylish</a>.

blocks|key|4204414|text|您可以编辑模板文件以添加您自己的样式表来覆盖现有的样式表。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|4204415|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

You could edit the template file to add your own stylesheet to override the existing one.

For ActionScript 2, I've used <a href="http://www.naturaldocs.org/" rel="noreferrer">NaturalDocs</a>. However it has pretty poor support for PHP. I've looked so far at <a href="http://www.doxygen.nl/" rel="noreferrer">doxygen</a> and <a href="http://www.phpdoc.org/" rel="noreferrer">phpDocumentor</a>, but their output is pretty ugly in my opinion. Does anyone have any experience with automatic documentation generation for PHP? I'd prefer to be able to use javadoc-style tags, they are short to write and easy to remember.

Automatic PHP Documentation Generation?

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

教程

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云智能顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云AI代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

功能1上新10个字符

功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符。

功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符。

功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符

功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符

功能4上新

文章&问答评论现已支持表情

全新交互，全新视觉，新增快捷键、悬浮工具栏、高亮块等功能并同时优化现有功能，全面提升创作效率和体验

社区富文本编辑器全新改版！诚邀体验～ 

精选全网热门MCP server，让你的AI更好用 🚀

💥开发者 MCP广场重磅上线！

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

聚焦“写作效率、视觉美观与运行性能”三方面进行全面升级，为您提供更高效、稳定的创作环境

社区富文本&Markdown编辑器全新改版上线，欢迎大家体验!

诚挚邀请您参与本次调研，分享您的真实使用感受与建议。您的反馈至关重要，感谢您的支持与参与！

社区新版编辑器体验调研

对于ActionScript 2，我使用了。然而，它对PHP的支持相当差。到目前为止，我已经研究了和，但在我看来，它们的输出相当难看。有没有人有过PHP文档自动生成的经验？我更喜欢使用javadoc风格的标签，它们写起来很短，也很容易记住。

问PHP文档自动生成？
EN

回答 9

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问PHP文档自动生成？EN

回答 9

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问PHP文档自动生成？
EN