什么是适当的PHP函数文档格式？
PHP文档是一种野生动物，即使是underscore_vsCamelCase样式也不是这样。 所以考虑到目前为止我所见过的所有types的PHP文档 – 标准是什么？ 我的函数和方法应该如何标记，以便大部分IDE和文档库可以读取它们？
在下面的例子中，（types）是以下之一：
- 布尔
- INT
- 排列
- 目的
- 串
- 浮动
和名称只是参数variables的名称（如$值）
/* * Function name * * what the function does * * @param (type) about this param * @return (type) */ function example((name)) /* * What the function does * * @param (name) about this param * @return (name) */ function example((name)) /** * Function name * * what the function does * * @param (type) (name) about this param * @return (type) (name) */ function example((name)) /** * Function name * what the function does * * Parameters: * (name) - about this param */ function example((name)) 根据霍伊尔的评论风格，没有官员。 你会发现最接近Zend框架的编码准则 。 Zend框架是由Zend生成的，它深深地涉及到了PHP的创build，所以你可以认为他们的编码准则是应该遵循的。
也可以认为，任何forms的评论
/** <--- starts with */ <--- ends with
是一个“官方”文档格式，因为这些格式将被parsing并通过reflectionAPI提供。 许多人利用这一点， PHPDoc格式产生正式的评论格式。
许多人使用PHPdoc作为标准。
<?php /** * I belong to a file */ /** * I belong to a class */ class Def { } /** * A summary informing the user what the associated element does. * * A *description*, that can span multiple lines, to go _in-depth_ into * the details of this element and to provide some background information * or textual references. * * @param string $myArgument With a *description* of this argument, these * may also span multiple lines. * * @return void */ function myFunction($myArgument) { } ?>
我认为PHPDoc是非常标准的。 另外你的问题之前被问过 （这可能会给你一些更多的想法）。
这可能是值得看看doxygen 。 它具有多语言支持和标准input格式。
