如何以内联方式记录PHP函数和类?

我知道有很多不同的标准PHP代码内联文档。这里是我的意思是内联文档,如果有一个更好的术语,请纠正我:

/**
* This is the description for the class below.
*
* @package    my-package
* @subpackage my-subpackage
* @author     my-name
* @version    my-version
* ...
*/
class orderActions {
...

什么是最好的和最广泛接受的形式的内联文档?有没有工具来自动生成这样的文档,或者它必须手工完成吗?

我不想生成手册 – 我想知道如何生成上面的代码注释类型,或“内联文档”。

PHPDoc,像你发布的,是一个广泛接受的PHP文档形式。

您可以使用Doxygen自动生成文档。

编辑:关于在代码中生成嵌入式文档,我从来没有遇到过一个工具,它会返回一个项目的外部。它通常留在IDE的领域,以生成模板,而你的代码。

Eclipse实际上做了一个体面的工作(这是我喜欢的Eclipse的少数事情之一),我相信Netbeans也一样。任何主要的IDE可能具有辅助这种类型的模板生成的功能。

http://stackoverflow.com/questions/1182781/how-do-you-document-your-php-functions-and-classes-inline

本站文章除注明转载外,均为本站原创或编译
转载请明显位置注明出处:如何以内联方式记录PHP函数和类?