开发者新闻:Xoops2 API 文档!

发布者:w4z004 阅读 6020 次
嗨!
我已经开始使用 phpDoc 记录 Xoops2 的核心 API,正如您在 CVS 中看到的。生成的文档可以在这里查看:http://xoops.sourceforge.net/xoops2doc/

这项工作远未完成,因为我从内核类开始,逐步完成。随着代码的增加,它将得到更新。

重要通知

每个人都应该阅读我的 phpDoc API 文档编写简介:(请偶尔查看,它可能会根据我们发现的最佳实践而略有变化。)
http://wiki.xoops.org/wakka.php?wakka=XoopsAndPhpDocumentor


由于 XOOPS 有很多代码,我不想永远这样做,所以每个人都应该记录他们编写的代码(...部分是 XOOPS 编码标准的一部分)!当你发现还没有文档的代码时,花一分钟时间为它写一些文档。在更改任何代码后,请确保文档仍然是正确的并保持在最新状态。

我对核心类的工作只是为了帮助开始文档。在未来,每个人都将负责记录他们工作的所有代码!不要因此而灰心。你会发现这并不是很多工作,甚至有助于你更好地理解自己在做什么。

Bunny