记录PHP代码 - 记录一组包含或需要的最佳方法

Question

3

您好，正如标题所示，我正在寻找记录 PHP 类文件中所需或包含组的最佳方法。每个 require 是否都应该有文档，并且是否有任何特定的 phpdoc 标签应该被使用。

- Bill

1

如果你要包含类，也许你想使用SPL Autoloaders。这些动态加载类，当你要使用它们时。这样你就不需要require_once类，而只需使用它们。 - NikiC

2个回答

0

所有的include和require文件都应该在文件顶部进行文档化说明。可以使用@category标签将它们分组。

- MANCHUCK

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Developer · Accepted Answer

有许多文档工具可供选择。你可以尝试其中任何一个。

JSDoc、phpDocumentor、OraDoclet、doxygen、phpdoc、PHPxRef。

我个人使用 doxygen 或 phpDocumentor。