Free Trial

Safari Books Online is a digital library providing on-demand subscription access to thousands of learning resources.

  • Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint
Share this Page URL
Help

Chapter 14. Documentation > Commenting Your Code

Commenting Your Code

Obviously, to provide documentation, you need to comment your code at the very least. However, if you’ve never commented your code before, you may find this slightly confusing given the various types of comment markers you can use. So, before you get into the tags that you can use in a comment block, let’s look at the various comment types and what they offer.

Basic Comment Types

First are the most common comment types used just to provide inline commenting or simple block commenting not for public consumption. By this, I mean that these types of comment markers are ignored by ASDoc when automatically generating your class documentation and, therefore, can be read only if you open the actual class itself. This style of comment can also be used as a delimiter on a single or multiple lines of code so that the compiler ignores them. Following are examples of these comment markers demonstrating their use as both information blocks and delimiters to bypass code elements when the application is compiled into a SWF.


  

You are currently reading a PREVIEW of this book.

                                                                                                                    

Get instant access to over $1 million worth of books and videos.

  

Start a Free 10-Day Trial


  
  • Safari Books Online
  • Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint