最好的方式来记录AJAX PHP代码？

发布时间：2020-12-16 01:35:41 所属栏目：百科来源：网络整理

导读：我一直用于记录代码,但是当涉及到 AJAX PHP时,并不总是容易的：代码真的被分散了！逻辑,数据,演示 – 您的名字 – 在服务器端和客户端代码之间进行拆分和混合.有时也有数据库端代码(存储过程,视图等)做一部分工作. 这给我提出了一个有效的方式记录这样的代码

我一直用于记录代码,但是当涉及到 AJAX PHP时,并不总是容易的：代码真的被分散了！逻辑,数据,演示 – 您的名字 – 在服务器端和客户端代码之间进行拆分和混合.有时也有数据库端代码(存储过程,视图等)做一部分工作.

这给我提出了一个有效的方式记录这样的代码.我通常提供.php文件内的.js文件列表以及.js文件内的.php文件列表.我还做了在线评论和功能描述,其中列出了什么文件使用什么函数以及预期的输出.我做类似的数据库过程任务.也许有更好的方法？

任何想法或经验？

注意：此问题适用于任何客户端服务器端应用程序,而不仅仅是Javascript PHP.

我认为最好采取层次化的方法.

对于api级别的文档,如函数和类级别,请使用许多文档工具(JSDoc,phpDocumentor,OraDoclet等),编写代码中的内联文档并从中生成html文档.如果您的文档工具可以与您的源代码控制工具进行集成,您可以跳转到您的api文档中的特定代码行,这样可以获得积分.

一旦你有了你的文档工具,开始生成文档作为构建过程的一部分(你有一个构建过程,对吗？)每个新的构建,并将文档推送到一个标准的网站.

一旦这些api文档在线,您可以创建一个Wiki,用于高级文档,例如浏览器> web->数据库交互,用户故事,架构图等.最好写在简短的散文或子弹点上文档,链接到api文档和源控件,必要时.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!