TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Are you talking about embedding comments in the code? An HTML comment
begins with "<!--", ends with "-->" and does not contain "--" or ">"
anywhere in the comment.
I need to annotate a section of HTML code with important notes and tips for
the user. Is there a standardized way of doing this without resorting to
footnotes? The code in question is code that users need to create an effect
in their websites, so it's not example code.