Start learning with our library of video tutorials taught by experts. Get started

CSS: Visual Optimization
Illustration by

Creating multiline comments


From:

CSS: Visual Optimization

with Justin Seeley

Video: Creating multiline comments

If and when you need to insert multiple lines inside of a comment, it's always a good practice to do what I called creating separator lines so that people understand that this is a huge block of comment that they need to pay attention to. Now if you've already watched the movie on Developing a CSS Table of Contents, you know exactly know what I'm talking about here. And there's a lot of different ways that people do this, and I'm going to show you a couple of those different ways now. So, in order to start a comment, of course you want to start with just a plain old basic syntax for writing out your comments. So you want to do the slash and then an asterisk to start it off, but if you're doing a multi-line comment, my suggestion is to just keep the asterisks going across, and I would suggest going about halfway across the page if not more.

Watch this entire course now—plus get access to every course in the library. Each course includes high-quality videos taught by expert instructors.

Become a member
please wait ...
CSS: Visual Optimization
1h 11m Beginner Feb 12, 2013

Viewers: in countries Watching now:

Take a tour of a workflow that optimizes CSS code for easier navigation, organization, and readability. In this course, author Justin Seeley covers best practices for writing CSS in an easy-to-read format, commenting code, developing a table of contents, and adopting other methods that help produce "cleaner" code. The course also contains tips for speeding up development with some online tools and simplification techniques.

Topics include:
  • Exploring good versus bad style sheets
  • Creating section headings
  • Indenting code for enhanced readability
  • Creating single- and multi-line comments
  • Avoiding unnecessary tags and classes
  • Creating master color and typography guides
  • Simplifying comments
Subjects:
Web Web Graphics Web Development
Software:
CSS
Author:
Justin Seeley

Creating multiline comments

If and when you need to insert multiple lines inside of a comment, it's always a good practice to do what I called creating separator lines so that people understand that this is a huge block of comment that they need to pay attention to. Now if you've already watched the movie on Developing a CSS Table of Contents, you know exactly know what I'm talking about here. And there's a lot of different ways that people do this, and I'm going to show you a couple of those different ways now. So, in order to start a comment, of course you want to start with just a plain old basic syntax for writing out your comments. So you want to do the slash and then an asterisk to start it off, but if you're doing a multi-line comment, my suggestion is to just keep the asterisks going across, and I would suggest going about halfway across the page if not more.

And then after that if you really want to create some space in here you can add another line of asterisks to this, this is really calling attention to whatever it is you're putting in there. And then you can start typing out your comments. So if you've seen my Table of Contents document, this is how I start off my table of contents and then I come in and type out something like, Section 1, header, Section 2, Body, et cetera. To close up the multi-line comment, all you have to do then is start typing out your asterisks again, get that all the way there, and all the way over like this, and once you get to the very end.

just close it with a trailing slash, like so. So you can see this is a more prominent thing, it also has a lot more space in the middle, we can write out multiple lines of comments. This is going to be for like big explanations of what's going on, defining big areas of content like headers, footers, bodies, defining the table of contents, all that kind of stuff. It can also be used as a declaration block at the top of your CSS to do things like who you are, so you could say something like, Author, you put in something like your website address, I mean all this different stuff, attribution to yourself, basically is what this amounts to.

And so, this is really just going a long way to calling attention to something and also separating it out from the rest of this information as well. Now, if you don't like this way of commenting, that's okay, you can also change it up a little bit, as long as you do the slash asterisk you could also do something like hyphens for this, and so you could do something like this, you go all the way across like that, and then you could do something like, This is my comment. Thanks for reading.

And then you can add some more hyphens underneath there. But just remember at the very end of this you do have to close it with an asterisk and a slash, something like that. And so again, it's up to you how you do this. In the end, I would recommend that you come in and play with this and develop your own style, but multi-line comments, things that span multiple lines or multiple paragraphs need to be well defined and they need to be highlighted in such a way that people understand exactly where they start and stop. And so, using techniques like I've just shown you here goes a long way towards doing that.

There are currently no FAQs about CSS: Visual Optimization.

 
Share a link to this course

What are exercise files?

Exercise files are the same files the author uses in the course. Save time by downloading the author's files instead of setting up your own files, and learn by following along with the instructor.

Can I take this course without the exercise files?

Yes! If you decide you would like the exercise files later, you can upgrade to a premium account any time.

Become a member Download sample files See plans and pricing

Please wait... please wait ...
Upgrade to get access to exercise files.

Exercise files video

How to use exercise files.

Learn by watching, listening, and doing, Exercise files are the same files the author uses in the course, so you can download them and follow along Premium memberships include access to all exercise files in the library.
Upgrade now


Exercise files

Exercise files video

How to use exercise files.

For additional information on downloading and using exercise files, watch our instructional video or read the instructions in the FAQ.

This course includes free exercise files, so you can practice while you watch the course. To access all the exercise files in our library, become a Premium Member.

join now Upgrade now

Are you sure you want to mark all the videos in this course as unwatched?

This will not affect your course history, your reports, or your certificates of completion for this course.


Mark all as unwatched Cancel

Congratulations

You have completed CSS: Visual Optimization.

Return to your organization's learning portal to continue training, or close this page.


OK
Become a member to add this course to a playlist

Join today and get unlimited access to the entire library of video courses—and create as many playlists as you like.

Get started

Already a member?

Become a member to like this course.

Join today and get unlimited access to the entire library of video courses.

Get started

Already a member?

Exercise files

Learn by watching, listening, and doing! Exercise files are the same files the author uses in the course, so you can download them and follow along. Exercise files are available with all Premium memberships. Learn more

Get started

Already a Premium member?

Exercise files video

How to use exercise files.

Ask a question

Thanks for contacting us.
You’ll hear from our Customer Service team within 24 hours.

Please enter the text shown below:

The classic layout automatically defaults to the latest Flash Player.

To choose a different player, hold the cursor over your name at the top right of any lynda.com page and choose Site preferencesfrom the dropdown menu.

Continue to classic layout Stay on new layout
Exercise files

Access exercise files from a button right under the course name.

Mark videos as unwatched

Remove icons showing you already watched videos if you want to start over.

Control your viewing experience

Make the video wide, narrow, full-screen, or pop the player out of the page into its own window.

Interactive transcripts

Click on text in the transcript to jump to that spot in the video. As the video plays, the relevant spot in the transcript will be highlighted.

Are you sure you want to delete this note?

No

Notes cannot be added for locked videos.

Thanks for signing up.

We’ll send you a confirmation email shortly.


Sign up and receive emails about lynda.com and our online training library:

Here’s our privacy policy with more details about how we handle your information.

Keep up with news, tips, and latest courses with emails from lynda.com.

Sign up and receive emails about lynda.com and our online training library:

Here’s our privacy policy with more details about how we handle your information.

   
submit Lightbox submit clicked
Terms and conditions of use

We've updated our terms and conditions (now called terms of service).Go
Review and accept our updated terms of service.