Home/ Questions/Q 7946023
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-06-04T01:01:54+00:00

I am making a library to generate some custom content. It is pretty verbose,

  • 0

I am making a library to generate some custom content. It is pretty verbose, about 1100 lines of code. Although the code is very readable and follows strict naming conventions, I am unsure where to document the API available when including the script file. When including the script in a page, intellisense does not pick up the “public” methods, nor does it for jQuery. jQuery has an awesome website for their API ( http://api.jquery.com/ ), but I do not feel inclined to make something as awesome as that.

Where should I document this custom API?

If in comments, what structure of comments would you suggest?

Edit

My point for intellisense was that even good naming conventions are going to require documented API. So I am definitely interested in a generic approach.

Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    It’s not generic, but if you didn’t mind maintaining separate versions for different editors, Visual Studio’s IntelliSense will load and parse XML comments in your JavaScript code. I would suppose MonoDevelop and SharpDevelop could use the same file as well, but I don’t think IDEs like IntelliJ or Eclipse would get any use out of it…

    HTH.

    • 0