在 CodeIgniter 项目上运行 phpdoc 时,应包含哪些文件夹?

发布于 2024-07-30 06:18:32 字数 125 浏览 5 评论 0原文

在我的第一次尝试中,我只包含系统/应用程序/模型、系统/应用程序/控制器、系统/应用程序/帮助程序和系统/应用程序/库。 我选择这些文件夹是因为我认为这些文件夹包含您想要正确记录以供将来参考的代码。 您认为还应该包含哪些其他文件夹?

On my first try, I've only included system/application/models, system/application/controllers, system/application/helpers, and system/application/libraries. I chose those folders because I think those folders contain the code that you want to be properly documented for future reference. What other folders do you think should be included?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

一世旳自豪 2024-08-06 06:18:32

对于您自己的代码要彻底。 我建议使用以下文件夹,并在必要时进行注释:

  1. system/application/controllers
  2. system/application/helpers
  3. system/application/hooks - Don不要错过这个! 任何时候你改变/扩展 CI 核心,你一定应该记录它
  4. 系统/应用程序/模型
  5. 系统/应用程序/库
  6. 系统/应用程序/语言 - 这在实现本地化时可能会很有用
  7. 系统/插件 - 当您包含库时,包含正在使用的任何外部插件也是有意义的

To be thorough in terms of your own code. I would recommend the following folders and where necessary have annotated:

  1. system/application/controllers
  2. system/application/helpers
  3. system/application/hooks - Don't miss this out! Any time that you change/extend the CI core, you should definitely document it
  4. system/application/models
  5. system/application/libraries
  6. system/application/language - This may come in useful when implementing localisation
  7. system/plugins - As you're including libraries, it would make sense to include any external plug-ins being used as well
看轻我的陪伴 2024-08-06 06:18:32

我想你已经涵盖了。 其余的可能已经记录在 CodeIgniter 的文档中。

如果您添加任何插件/库/任何需要位于这些文件夹之外的内容,请确保稍后也添加它们。

I think you got it covered. The rest is probably documented in CodeIgniter's documentation already.

If you add any plugin/library/whatever that requires to be outside of these folders, make sure you add them later as well.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文