我正在製作一個庫來生成一些自定義內容。它非常冗長，大約有1100行代碼。儘管代碼非常易讀，並且遵循嚴格的命名約定，但我不確定在包含腳本文件時，在哪裏記錄可用的API。將腳本包含在頁面中時，intellisense不會選擇「公共」方法，也不會用於jQuery。 jQuery爲他們的API提供了一個很棒的網站（http://api.jquery.com/），但我並不覺得自己喜歡這樣的東西。在製作JavaScript庫時，哪裏是記錄API的好地方？
我應該在哪裏記錄這個自定義API？
如果在評論中，您會建議哪種結構的評論？
編輯
我點智能感知是，即使良好的命名約定將需要記錄的API。所以我絕對對通用方法感興趣。
它不是通用的，但如果您不介意爲不同的編輯器維護不同的版本，Visual Studio的IntelliSense將加載和解析JavaScript代碼中的XML註釋。我會假設MonoDevelop和SharpDevelop也可以使用相同的文件，但我不認爲像IntelliJ或Eclipse這樣的IDE會得到任何用處...
HTH。
我更想的是如何顯示沒有作爲你關於intellisense的評論的一個便箋，vs真的很擅長這個，在你的視圖中有一個不可及的if（false）{}塊，然後在它內部引用腳本Intellisense會自動完成它的工作（你可能不得不按Ctrl + Shift + j來重新加載） –
我選擇這個作爲答案，因爲它指向我在XML註釋中註釋，這實際上是非常棒的。 –
我認爲jsdoc非常受歡迎。
http://code.google.com/p/jsdoc-toolkit/
你會內嵌文件，下面的鏈接的約定。你會分配一個精縮/模糊的生產版本進行部署，並記錄一個發展（即你能做到這一點）
編輯，你也可以在這裏找到更多的選擇：http://o2js.com/2011/05/01/how-to-document-a-javascript-framework/
這取決於多麼複雜你的API是，我自己的小庫，我只是做一個大的意見，在包含文件的頂部
基本上這就是你在C頭文件中的內容。
我想你可以在一個單獨的文件中完成我上面提到的所有事情，然後使用markdown語法（我太懶了...我也更喜歡把所有東西放在一個文件中）。
p.s.有些人提到內聯評論（即直接在功能上）。 這當然也是一種選擇。但對我來說，這似乎是方便的，只有當文檔自動生成時，這是一個可怕的方式來快速研究文件內的文檔，因爲它缺乏一個大的圖片視圖。
如果您希望我爲每個人添加或更改某項內容，請發表評論。否則，請張貼答覆，以便我可以授予信用。 –
你只是在尋找Visual Studio IntelliSense支持，或者更通用的東西？ –
我認爲評論應該在編碼的時候完成，而不是之後......好運現在瞭解你的代碼：s – ajax333221