Javascript对ajax调用的评论

Question

目前我在记录javascript函数时使用phpDoc样式注释，主要是因为我习惯了语法，我觉得phpDoc是一个很好的，全面的评论风格。

但它没有涵盖的一件事是Ajax请求（显然），我想知道是否有一套标准来评论这些？或者，如果有人对最佳方式有任何建议，可以评论通话正在做什么，应该返回什么等等。

Answer 1

为了保持phpdoc风格，我会把AJAX调用视为一个函数，主要使用自由文本描述来描述预期的细节。这就是你对函数所做的事情，并且没有现有的AJAX调用AFAIK标准，所以就这样做。也许你可以开始一个！有关它的博客。

Answer 2

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