ajax 调用的 Javascript 注释
目前我在记录 javascript 函数时使用 phpDoc 风格的注释，主要是因为我已经习惯了语法，并且我觉得 phpDoc 是一种很好的、全面的注释风格。
但它没有涵盖的一件事是 Ajax 请求（显然），我想知道是否有一套标准来评论这些请求？或者，如果有人对评论调用正在做什么、应该返回什么等的最佳方式有任何建议。
At the moment I use phpDoc style comments when documenting javascript functions, mainly because I am used to the syntax and I feel that phpDoc is a good, comprehensive commenting style to adopt.
One thing it doesn't cover though is Ajax requests (obviously) and I was wondering if there was a set standard for commenting these? Or if anyone had any suggestions on the best way to comment what the call is doing, what it should return, etc.
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（2）
为了保持 phpdoc 风格，我将 AJAX 调用视为一个函数，并主要使用自由文本描述来描述预期内容的细节。这就是您对函数所做的事情，而且目前还没有 AJAX 调用的标准，所以就这样做吧。也许你可以开始一个！关于它或其他东西的博客。
In order to stay with the phpdoc style, I would treat the AJAX call like it's a function, and mainly use the free text description to describe the detail of what's expected. That's what you do with functions, and there's no existing standard for AJAX calls AFAIK, so just do that. Maybe you could start one! Blog about it or something.
阅读这篇关于 javascript 代码文档和生成文档文件的精彩文章@ dailyjs .com - 它应该为您提供所需的信息。
Read this great article about javascript code documentation and generating documentation files @ dailyjs.com - it should set you up with what you need.