【问题标题】:Automatic INLINE Document Generation自动内联文档生成
【发布时间】:2011-02-09 09:29:11
【问题描述】:

首先,我不是在问如何从 PHP 源代码生成文档。使用 Doxygen 或 PHPDocumentor 之类的库很容易做到这一点。我正在寻找的是一种为类、方法、属性等自动生成基于 phpdoc 的内联注释存根的方法。是否有任何预先存在的库可以做到这一点?我做了一些搜索,但一无所获。

我只是问,因为我有一种痒,我想自己写。我倾向于一次花费数小时编写代码,将文档保存为最后一步(我知道,我真的应该边做边做)。问题是,即使意识到内联文档的重要性,在连续 8 小时编码和编写具有数十种方法和属性的十几个类之后,不得不停下来开始编写这些东西有点令人反感。

显然,我无法自动创建 COMPLETE 文档。诸如类、属性和方法的详细描述之类的东西必须手动输入。但是,使用反射,我可以轻松获得足够的信息来创建带有填空占位符的评论存根。

如果有人可以帮助我寻找这样的解决方案,太棒了。如果没有,我将创建一个新的 Github 存储库并为社区贡献一些有用的东西。 :)

【问题讨论】:

  • 很多IDE(比如Eclipse)都有可以为你生成PHPDoc存根的功能
  • +1 是的,我实际上正在寻找一种以编程方式执行此操作的方法。基本上,从命令行运行它并指定一个目录(+filters)来遍历和记录。我实际上知道 Eclipse 会这样做,但不幸的是,我使用的是 Netbeans,但似乎找不到这个功能。无论哪种方式,这将是一个有趣的小宠物项目。 :)
  • +1 哇,正是我想要的!谢谢,佩卡!随意添加一个实际的答案,我会接受它。 :)

标签: php reflection documentation code-documentation


【解决方案1】:

DocumentX 可能(重复可能)能够做到这一点。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2015-06-02
    • 1970-01-01
    • 1970-01-01
    • 2010-09-16
    • 2015-11-25
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多