App Documentation -- How To

  • Hi all,

    The project I'm working on with Ext seems to be getting bigger each week, and I'm now at the point where I need to start documenting the code so that others can understand it. I've scanned through the forums for ways to document the code, but it seems like everyone and their uncle has a different way to do it...

    My question is, how are the clever Ext people effectively documenting code? Another way of asking this is whether there is an "official" or "standard" way to create documentation when developing a growing Ext app that will work with all of the Ext preconfigured classes and other goodies...

    What documentation process are you using? Thoughts/ideas are greatly appreciated!


  • We are using JSDoc with Ext plugin to document. You can find the info in other threads on the forum. I was able to prepare our app/ framework doc using this and you can see the output sample at http://www.durlabhcomputers.com/framework/DAExt/. If you need my modifications, please PM me.


  • I can't speak for the Ext team, but in my project, we use the same style of documentation that Ext uses in the hope that one day they will make their amazing API doc generator available to us!







  • #If you have any other info about this subject , Please add it free.#
    Your name:
    E-mail:
    Telphone:

    Your comments:


    If you have any other info about App Documentation -- How To , Please add it free.