Website commenting, What is it? Why should you or your developer comment your code of your website?
Well, the simple answer is basically commenting or annotations are directions left by developers in the code that they develop. This can be very useful and instructional for website projects that have more than one developer, for websites that are extremely large or for websites that have complicated functions. These comments can speed up trouble shooting, adding additional functions to a website, or expanding a website.
Commenting inside the code can also be very useful and save a great deal of time and money if you have to move your site from one development company to another.
Now, that you have a basic understanding of having commenting inside your website. Let’s actually take a look at commenting the code of your website.
EXAMPLE 1 Cascading Style Sheet
#wrapper{
width:950px;
height:100%;
margin:15px auto;
border:10px solid #000;
background-color:#fff;
overflow:auto;
}
Example 1 above is what is called a DIV tag inside a Cascading Style Sheet. This DIV controls the width and
height of the wrapper in also sets the margin, border, background color and whether the wrapper should overflow its pre-determined width and height. There is no comment with this statement. In the next Example; you will see the comment that belongs with this piece of code.
EXAMPLE 2
/* The wrapper below controls the entire site main layout and it also sets the width,
height, margin, border, background color and the overflow. This is universal for the
entire site and used globally */
#wrapper{
width:950px; height:100%; margin:15px auto; border:10px solid #000; background-color:#fff; overflow:auto; }
Your entire website should always be commented from the Cascading Style Sheet, Javascript, Jquery, HTML, or any programming language that has been used to develop your website. This is something that most developers do not do for their clients, but this is something you should always ask for when getting a website developed. It is always overlooked and most customers do not know to even ask about commenting.
If you would like Mojoe.net to discuss developing your web site, web application, need custom programming, or IT consultant, please do not hesitate to call us at 864-859-9848 or you can email us at dwerne@mojoe.net
If you would like to discuss Your Logo with Mojoe.net or your website’s analytics, custom logo designs, social media, website, web application, need custom programming, or IT consultant, please do not hesitate to call us at 864-859-9848 or you can email us at dwerne@mojoe.net.
Recent Comments