14. Documentation

Although this may be the final chapter in this book, it is probably the most import chapter—not only in relation to component development, but also for software development in general. This chapter gives you a feel for the level of documentation that a commercial component requires and advice on how to incorporate code comments in your components as you develop your own component library. It also shows how to hook those in to the auto documentation tool ASDoc.

Finally, this chapter shows you how to use some third-party tools to make the insertion of comments a less painful process and, ultimately, save you time and effort. Without further ado, let’s get documenting....

Why Should I Document Code?

Documentation is often treated ...

Get Developing Flex 4 Components: Using ActionScript 3.0 and MXML to Extend Flex and AIR Applications now with O’Reilly online learning.

O’Reilly members experience live online training, plus books, videos, and digital content from 200+ publishers.