使用phpdoc2记录php文件的指南

开始记录我的项目，第一次使用phpdoc2，我遇到了几个问题。我确实读过phpdoc.org上的指南

使用phpdoc2时是否有记录内容的指南？ 我必须记录所有变量还是仅记录特定范围/可视性中的变量

据我现在所知，您记录了以下各项：

• 文件
• 阶级
• 作用

---

但即便如此。。。使用这些标签可以走多远？

文档应该涵盖所有最重要的内容。如果可能的话，你甚至可以举出例子、外部链接等等。我使用了doxygen软件，发现它非常好，并且它有这些特性

php.net手册非常好。它涵盖了每个函数、类、方法，还包括需求、介绍等

对我来说，最糟糕的问题是我记录了每一个细节，在某个时刻我说“我厌倦了”，并停止记录或评论最重要的部分。“我会记住的”

在一个月或一年之后，删除太长或多余的内容总是比填充缺少的内容更容易

---

找到你的观点。

记住，在六个月的时间里，当你的记忆不够新鲜时，你为自己（或其他可能需要更改代码的人）记录的内容也一样多；因此，您需要尽可能多的级别来记录文档