tbarstow
3 Jan 2008, 12:03 PM
Has there been any discussion of a commenting feature for the API docs? (Similar to PHP's documentation, for example.)
I know you guys have a lot on your plate, but I think this could be really useful - both to the community and to the Ext team.
Some benefits off the top of my head:
1. Decreased forum traffic, as answers to common questions would be readily available right in the API docs
2. Better documentation for end users; rather than spending loads of time searching the forum, the information you're often looking for would be right there in front of you
3. An empowered community; by empowering users to add to the documentation, you give them a greater sense of involvement which can only make the community stronger
I've been a professional PHP developer for years now, I've found the comments in their manual to be incredibly useful. Not only have I found some great information in there (saving me untold hours of work), but I've been able to post it as well.
Anyway, just my $.02. Thanks!
I know you guys have a lot on your plate, but I think this could be really useful - both to the community and to the Ext team.
Some benefits off the top of my head:
1. Decreased forum traffic, as answers to common questions would be readily available right in the API docs
2. Better documentation for end users; rather than spending loads of time searching the forum, the information you're often looking for would be right there in front of you
3. An empowered community; by empowering users to add to the documentation, you give them a greater sense of involvement which can only make the community stronger
I've been a professional PHP developer for years now, I've found the comments in their manual to be incredibly useful. Not only have I found some great information in there (saving me untold hours of work), but I've been able to post it as well.
Anyway, just my $.02. Thanks!