#THE BEST PLACE TO WRITE HTML CODE HOW TO#

It might be a short snippet that focuses on a specific task (for example, how to cause a button to change color using the onhover event), or a longer tutorial or how-to. It shows how to use a specific member or how to accomplish a specific task. List any requirements for each code sample or snippet in its description.īroadly speaking, there are two sizes for example code: code snippets and code samples.Ĭode snippet: A code snippet is any example in the documentation.List any assumptions the code sample or snippet makes and state prerequisites clearly and completely in its description. Ensure that the text leading up to the sample code has a clear description of what that code accomplishes.For example, use feature detection rather than browser sniffing. Follow coding best practices, where they are clear.Their purpose is to demonstrate specific functionality, not what a clever programmer you are. Code samples and snippets should be simple and brief.html file, code samples should indicate where the code fits in with required elements. Because of its special regard, code requires special attention.Īt the most basic level, effective code samples and snippets should follow these top five guidelines: Developers use samples as documentation, and they almost always browse code before reading a topic fully. Sample code serves as a mini-portal to content. It is meant to provide a quality bar for code samples and snippets, and to provide consistency of style across this documentation, not functionality. This topic provides guidance for writing code and markup samples and snippets for documentation published to. Guidelines to follow for developing code samples in Web Platform Docs.

The best place to write html code