php - 使用 phpdoc2 记录 php 文件的指南

Question

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

是否有使用 phpdoc2 时要记录什么的指南？我必须记录所有变量还是仅记录某个范围/可见性中的变量。

据我所知，您记录了每个：

• 文件
• 班级
• 功能

但即便如此......您使用标签能走多远？

Answer 1

文档应涵盖所有最重要的内容。如果可能，您甚至可以提供示例、外部链接等。我用的是doxygen软件，觉得很不错，这个有这些功能。

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

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

一个月或一年后删除太长或多余的东西总是比填补缺失的东西更容易。

找到你的观点。