你用什么来记录网站程序,基础设施和代码?

时间:2011-07-13 18:40:55

标签: php code-documentation

我在看http://www.phpdoc.org/,但想知道你们发现了什么有用的东西。我想要的东西可以帮助记录我们的代码,还需要在网站上频繁执行的程序和任务。在linux / PHP / MySQL环境中,最好的解决方案是什么?

3 个答案:

答案 0 :(得分:1)

PHPDoc是要走的路。

你将拥有:

  • 自行生成的文档文件;
  • 支持它的编辑器上的上下文功能文档(很多);
  • 检查文档是否是最新的简单方法(每次使用函数/方法时都会看到docblock; DOCS文件夹通常注定要忘记 - 如果你不工作,你只看它们在一个项目上一段时间,并且在那时它们几乎会自动过时);
  • 因为我猜你无论如何都会使用docblocks,所以必须保留一个单独的docs文件夹并没有多大意义。

答案 1 :(得分:0)

您受版本控制的DOCS文件夹。对于仪表板存档,我发现照片很有用。

答案 2 :(得分:0)

phpdoc仅用于记录代码。它并不意味着记录架构。您可以使用UML