【问题标题】:What do you use to document site procedures, infrastructure and code? [closed]你用什么来记录站点程序、基础设施和代码? [关闭]
【发布时间】:2011-07-13 18:40:54
【问题描述】:

我正在查看http://www.phpdoc.org/,但想知道你们发现什么有用。我想要一些有助于记录我们的代码的东西,以及在网站上经常执行的程序和任务。在 linux/PHP/MySQL 环境中最好的解决方案是什么?

【问题讨论】:

    标签: php code-documentation


    【解决方案1】:

    PHPDoc 是要走的路。

    你将拥有:

    • 自行生成的文档文件;
    • 支持它的编辑器上的上下文函数文档(很多);
    • 检查您的文档是否是最新的一种简单方法(每次使用函数/方法时都会看到文档块;DOCS 文件夹通常注定要被遗忘 - 只有在您不工作时才查看它们在一个项目上呆了一段时间,到那时它们几乎会自动过时);
    • 由于我猜您无论如何都会使用 docblocks,因此必须维护一个单独的 docs 文件夹并没有多大意义。

    【讨论】:

    • 我尝试使用 1.4.3 版本的 PHPDoc,但在生成模板文件时失败并出现一些错误
    【解决方案2】:

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

    【讨论】:

    • 这并不容易搜索,因为您无法搜索文件的上下文。
    • @Webnet:如果您需要上下文,大多数文件格式都可以存储元信息。
    【解决方案3】:

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

    【讨论】:

      猜你喜欢
      • 2020-07-08
      • 1970-01-01
      • 2021-01-25
      • 2020-08-27
      • 2011-01-07
      • 1970-01-01
      • 1970-01-01
      • 2021-06-27
      • 1970-01-01
      相关资源
      最近更新 更多