ajax调用的Javascript注释

ajax调用的Javascript注释,javascript,ajax,comments,Javascript,Ajax,Comments,目前,我在编写javascript函数文档时使用phpDoc风格的注释,主要是因为我习惯了语法,并且我觉得phpDoc是一种很好的综合注释风格 但有一件事没有涉及到Ajax请求(很明显),我想知道是否有一个对这些请求进行评论的标准?或者,如果有人对评论调用正在做什么、它应该返回什么等的最佳方式有任何建议。为了保持phpdoc风格,我会将AJAX调用视为一个函数,并主要使用自由文本描述来描述预期的细节。这就是您对函数所做的,而且目前还没有AJAX调用AFAIK的标准,所以就这样做吧。也许你可以开始

目前,我在编写javascript函数文档时使用phpDoc风格的注释,主要是因为我习惯了语法,并且我觉得phpDoc是一种很好的综合注释风格


但有一件事没有涉及到Ajax请求(很明显),我想知道是否有一个对这些请求进行评论的标准?或者,如果有人对评论调用正在做什么、它应该返回什么等的最佳方式有任何建议。

为了保持phpdoc风格,我会将AJAX调用视为一个函数,并主要使用自由文本描述来描述预期的细节。这就是您对函数所做的,而且目前还没有AJAX调用AFAIK的标准,所以就这样做吧。也许你可以开始一个!关于它或其他的博客。

关于javascript代码文档和生成文档文件@dailyjs.com-它应该为您提供您需要的内容。

干杯!别担心,这不是投票而是分享爱呵呵