你如何内联记录你的PHP函数和类？[已关闭]

php documentation comments

2022-08-30 12:16:23

我知道PHP代码内联文档有许多不同的标准。这就是我所说的内联文档的意思，如果有更好的术语，请纠正我：

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

什么是最好和最广泛接受的内联文档形式？换句话说，每个人都同意的内联文档形式是什么，并且不是基于意见的;每个人都应该知道的普遍接受的PHP内联文档形式，但作为一个提问者，我还不确定，但是在回答了这个问题之后，我将有一个很好的概述，不涉及任何特定的意见。

是否有任何工具可以自动生成此类文档，或者必须手动完成？

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

答案 1

PHPDoc，就像你发布的内容一样，是一种被广泛接受的PHP文档形式。

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

编辑：在代码中生成内联文档方面，我从未遇到过一个工具可以返回并在外部为项目执行此操作。它通常保留在 IDE 领域，以便在编写代码时生成模板。

Eclipse在这方面做得不错（这是我喜欢Eclipse的为数不多的事情之一），我相信Netbeans也是如此。任何主要的 IDE 都可能具有帮助生成此类模板的功能。

答案 2

从以下选项中选择：

另请参阅维基百科文章“文档生成器的比较”，“按语言”部分。