DV.*_*DV. 10 php documentation ajax
我一直都在记录代码,但是当谈到AJAX + PHP时,它并不总是那么简单:代码真的很分散!逻辑,数据,演示 - 您的名字 - 在服务器端和客户端代码之间进行拆分和混合.有时,还有数据库端代码(存储过程,视图等)执行部分工作.
这让我想出了一种有效的方法来记录这些代码.我通常在.php文件中提供.js文件列表以及.js文件中的.php文件列表.我还进行内联注释和函数描述,其中列出了哪个函数被哪个文件使用以及期望的输出.我为数据库程序执行类似的任务.也许有更好的方法？
任何想法或经验？
注意:此问题适用于任何客户端+服务器端应用程序,而不仅仅是Javascript + PHP.
我认为最好采取分层方法。
对于 api 级别的文档（例如函数和类级别），请在代码中编写内联文档，并使用许多文档工具（ JSDoc、phpDocumentor、OraDoclet等）从中生成 html 文档。如果您的文档工具可以与源代码管理工具集成，那么您就可以从 api 文档跳转到特定代码行，这是加分项。
准备好文档工具后，开始为每个新构建生成文档作为构建过程的一部分（您有一个构建过程，对吧？），并将文档推送到标准 Web 位置。
一旦这些 api 文档上线，您就可以为高级文档创建一个 wiki，例如浏览器->网络->数据库交互、用户故事、模式图等。最好用简短的散文或要点来编写高级文档，必要时链接到 api 文档和源代码控制。