2011-07-13 24 views

回答

0

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

+0

由于您无法搜索文件的上下文,因此不容易搜索。 – Webnet

+0

@Webnet:如果您需要上下文,大多数文件格式都可以存储元信息。 – hakre

1

PHPDoc是要走的路。

您将有:

  • 自我生成的文档文件;
  • 支持它的编辑器上的上下文功能文档(其中很多);
  • 一种简单的方法来检查您的文档是否是最新的(每次使用函数/方法时都会看到docblock; DOCS文件夹通常注定会被遗忘 - 如果您没有工作,您只能看到它们在一个项目上一段时间,并在那一点上,他们几乎会自动过时);
  • 由于我猜你会使用docblocks,所以不必为了维护一个单独的docs文件夹而产生大量的意义。
+0

我尝试使用版本1.4.3的PHPDoc,并且在生成模板文件时失败并出现一些错误 – Webnet

0

phpdoc仅用于记录代码。它并不是要记录架构。你可以使用UML