Javascript評論爲ajax調用

Question

目前我在使用phpDoc樣式註釋來記錄javascript函數時，主要是因爲我習慣了語法，我覺得phpDoc是一種很好的綜合評論風格。

但它沒有涵蓋的一件事是Ajax請求（顯然），我想知道是否有一個標準的評論這些？或者如果任何人有任何建議，最好的方式來評論電話正在做什麼，它應該返回什麼，等等。

Answer 1

爲了保持phpdoc風格，我會把AJAX調用看作是一個函數，並且主要使用自由文本描述來描述預期的細節。這就是你對函數做的事情，並且AJAX調用AFAIK沒有現有的標準，所以就這麼做。也許你可以開始一個！博客關於它的東西。

Answer 2

Read this great article關於JavaScript代碼文檔和生成文檔文件@ dailyjs.com - 它應該爲你設置你所需要的。