Because asterisks (*) are used to delimit comments, ASDoc does not support asterisks within a comment. To use
an asterisk in an ASDoc comment, you must use the double tilde (~~).
Hiding text in ASDoc comments
The ASDoc style sheet contains a class called hide, which you use to hide text in an ASDoc comment by setting
the class attribute to
hide. Hidden text does not appear in the ASDoc HTML output, but does appear in the
generated HTML file so you should not use it for confidential information. The following example uses the
hide
class:
/**
*Dispatched when the user presses the Button control.
*If the <code>autoRepeat</code> property ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month, and much more.
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.
Julian F.
Head of Cybersecurity
I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.
Addison B.
Field Engineer
I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.
Amir M.
Data Platform Tech Lead
I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.