2011-07-13 61 views

回答

0

您擁有版本控制下的DOCS文件夾。對於儀表板存檔,我發現照片很有用。

+0

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

+0

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

1

PHPDoc是要走的路。

您將有:

  • 自我生成的文檔文件;
  • 支持它的編輯器上的上下文功能文檔(其中很多);
  • 一種簡單的方法來檢查您的文檔是否是最新的(每次使用函數/方法時都會看到docblock; DOCS文件夾通常註定會被遺忘 - 如果您沒有工作,您只能看到它們在一個項目上一段時間,並在那一點上,他們幾乎會自動過時);
  • 由於我猜你會使用docblocks,所以不必爲了維護一個單獨的docs文件夾而產生大量的意義。
+0

我嘗試使用版本1.4.3的PHPDoc,並且在生成模板文件時失敗並出現一些錯誤 – Webnet

0

phpdoc僅用於記錄代碼。它並不是要記錄架構。你可以使用UML

相關問題