Documenting Javascript doc comments

  • Article

Bertrand Leroy, a Software development Engineer, from AJAX team is currently representing Microsoft at the OpenAjax Alliance working group. You can read about the working group’s intentions and planning here: https://www.openajax.org/member/wiki/IDE_Charter.

Today Bertrand bloged about the format of Javascript doc comments. Xml documentation annotations are going to drive JavaScript IntelliSense in Visual Studio Orcas (the next version of Visual Studio). For more than a year now, we've been including xml doc comments to all public APIs in the Microsoft Ajax Library (which are a great place to check out some examples of those comments). You can get more information at his blog https://weblogs.asp.net/bleroy/archive/2007/04/23/the-format-for-javascript-doc-comments.aspx.

I have been working with Bertrand to find ways for Sandcastle to generate documentation for Javascript doc comments. He has developed a cool document extraction tool that will generate reflection.org file for Sandcastle. Look for more details in his blog and my future blog.

 Anand..