Easy-to-follow video tutorials help you learn software, creative, and business skills.Become a member

Commenting code

From: ASP.NET Essential Training

Video: Commenting code

As with all good programming languages, both Visual Basic and C# support the ability to add comments to your code. You can use comments to document features in your code that otherwise might not be easy to figure out, or to temporarily block certain code from executing. I will demonstrate how to add comments in both languages. I'll start with the file LoopingCSharp.aspx. This page already has the functionality to execute a couple of loops, a For loop and a While loop. I'll save the file under a new name selecting File > Save As. I'll name the file CommentsCSharp.aspx.

Commenting code

As with all good programming languages, both Visual Basic and C# support the ability to add comments to your code. You can use comments to document features in your code that otherwise might not be easy to figure out, or to temporarily block certain code from executing. I will demonstrate how to add comments in both languages. I'll start with the file LoopingCSharp.aspx. This page already has the functionality to execute a couple of loops, a For loop and a While loop. I'll save the file under a new name selecting File > Save As. I'll name the file CommentsCSharp.aspx.

You can comment code in C# in one of two ways. You can either use beginning of line comments which are double slash characters, which prevent code from executing from a certain point of the line to the end of the line or you can use Block comments. A block comment starts with a slash and an asterisk and end with an asterisk slash. For example, let's say that you wanted to add a comment above the runButton_click function to describe what it does. This would be best served as a block comment. So I'll place the cursor above the function, I'll put in a slash asterisk and then I'll type in some comments, such as this function walks up and down a variable.

Notice that when I press Enter at the end of the line, Visual Web Developer automatically puts in an asterisk. This is a visual trick. If you have a long comment that's a full paragraph, placing the asterisk at the beginning of every line is just a way of visually indicating to the developer that the comment is continuing, but in order to actually complete the comment, you must end with the asterisk slash character. Notice that Visual Web Developer color- codes this sort of comment in black. So that's how you create a block comment. Now here is how you create a beginning of line comment. You can actually do this with a keyboard shortcut. I'm going to select the While loop. Then I'll go to the menu and I'll select Edit > Advanced.

Notice that you can comment and uncomment the selection from the menu. I'll comment the selection with the menu choice. You will see that when you use the menu choice or it's associated keyboard shortcut, you are using beginning of line comments, the double slash combination. Now to uncomment that same code, I'll press Ctrl+K. Notice at the bottom of the Visual Web Developer interface there is a message. (Ctrl+K) was pressed, waiting for second key of chord. A chord is a combination of keyboard shortcuts one after the other. So now I'll press Ctrl+U and that removes the comments.

Ctrl+K, Ctrl+C to add the comments in; Ctrl+K, Ctrl+U to remove them. I will go ahead and leave them in the final stage of this application. I'll save the changes. I'll run the page without debugging and now when I run the code, I'll only see the output from the For loop. I won't see the output for the While loop, because it's commented out. Now, I'll do the same thing in Visual Basic. I'll open the file LoopingVB.aspx.

I'll save the file, naming the new file CommentsVB.aspx. I'll place the cursor above the function runButton_Click. I'll expand to full screen by pressing Alt+Shift+Enter. Now with Visual Basic, you only get beginning of line comments, there is no block comment. So for each line that I would like to comment, I start up with a single quote character. Then I type in the comment. Now if you want to add or remove comments for multiple lines, you can use the same keyboard shortcut that I already demonstrated for C#. I'll select all of the code for the While loop, I'll press Ctrl+K. Notice that Visual Web Developer adds the single quote comment at the beginning of every line. To remove the comment, Ctrl+K, Ctrl+U.

Once again, I'll leave those comments in for the ending state of the file. I'll save my changes and I'll run the page. When the page appears in the browser, I'll run the code. Now I only see the results of the For loop because the While loop is commented out. You are strongly encouraged to comment freely. Use comments to document your code or to temporarily block code from being executed when you are doing your development and testing.

Show transcript

This video is part of

Image for ASP.NET Essential Training
ASP.NET Essential Training

79 video lessons · 48568 viewers

David Gassner
Author

 
Expand all | Collapse all
  1. 18m 44s
    1. Welcome
      1m 42s
    2. Prerequisites
      2m 21s
    3. Using the exercise files
      1m 32s
    4. Upgrading exercise file websites for ASP.NET 4.5 (NEW)
      2m 40s
    5. What's new in ASP.NET 4 (NEW)
      3m 48s
    6. What's new in ASP.NET 4.5 (NEW)
      3m 23s
    7. What's new in this course update (NEW)
      3m 18s
  2. 33m 34s
    1. Understanding how ASP.NET works
      5m 52s
    2. Installing Microsoft Visual Web Developer 2008
      3m 43s
    3. Installing Visual Studio Express 2012 for web (NEW)
      2m 12s
    4. Hello World: Creating your first ASP.NET web site
      4m 28s
    5. Creating pages with dynamic output
      7m 39s
    6. Understanding the development web server
      4m 49s
    7. Exploring the development environment
      4m 51s
  3. 40m 2s
    1. Understanding Microsoft SQL Server
      5m 47s
    2. Installing SQL Server Express
      6m 51s
    3. Exploring SQL Server Management Studio Basic
      4m 23s
    4. Creating a new database
      8m 51s
    5. Connecting to the database in ASP.NET
      5m 35s
    6. Testing SQL queries
      3m 53s
    7. Presenting a dataset in an ASP.NET page
      4m 42s
  4. 25m 31s
    1. Understanding ASP.NET web form pages
      5m 51s
    2. Separating presentation and logic with code files
      4m 17s
    3. Adding web form controls to a page
      5m 25s
    4. Handling postback data in a web form page
      5m 50s
    5. Using data binding expressions
      4m 8s
  5. 48m 37s
    1. Creating a testing environment
      4m 40s
    2. Declaring and using a simple variable
      6m 14s
    3. Declaring and using a complex object
      6m 16s
    4. Using loops
      6m 52s
    5. Using functions
      9m 25s
    6. Using trace statements
      4m 47s
    7. Debugging with breakpoints
      5m 45s
    8. Commenting code
      4m 38s
  6. 17m 43s
    1. Creating web controls
      5m 53s
    2. Registering a user control on a web form page
      3m 25s
    3. Registering controls globally in the web.config file
      3m 53s
    4. Adding public properties to a web control
      4m 32s
  7. 19m 7s
    1. Understanding Cascading Style Sheets (CSS)
      5m 36s
    2. Attaching external CSS files
      3m 12s
    3. Defining a CSS selector
      6m 10s
    4. Using CSS class selectors in server controls
      4m 9s
  8. 30m 34s
    1. Presenting data with the GridView control
      5m 49s
    2. Controlling GridView paging and appearance
      5m 46s
    3. Editing data with the GridView control
      6m 57s
    4. Presenting data with the DataList control
      5m 42s
    5. Formatting data with binding expressions
      6m 20s
  9. 36m 46s
    1. Using the DetailsView control
      7m 33s
    2. Inserting data with the DetailsView control
      6m 36s
    3. Redirecting page requests
      9m 39s
    4. Creating an update page
      6m 20s
    5. Linking to update pages from the list page
      4m 3s
    6. Deleting database records
      2m 35s
  10. 22m 15s
    1. Customizing forms with item editing templates
      6m 7s
    2. Adding validator controls to a form
      6m 40s
    3. Controlling the validation error message display
      6m 24s
    4. Using the ValidationSummary control
      3m 4s
  11. 29m 49s
    1. Creating a query with joined tables
      8m 6s
    2. Replacing control style properties with CSS
      5m 50s
    3. Creating a CSS file for printing
      3m 14s
    4. Suppressing elements in printed web pages
      5m 47s
    5. Selecting data for a report
      6m 52s
  12. 11m 14s
    1. Understanding ViewState and managing postbacks
      4m 36s
    2. Using session variables
      6m 38s
  13. 20m 57s
    1. Turning on forms authentication
      1m 51s
    2. Creating a page to log in users
      4m 18s
    3. Creating a page to set up new users
      4m 6s
    4. Understanding the security database
      3m 27s
    5. Configuring security in the web.config file
      2m 59s
    6. Creating a page to log out users
      4m 16s
  14. 27m 56s
    1. Installing IIS on Windows XP
      6m 32s
    2. Installing ASP.NET 3.5 on Windows XP
      1m 39s
    3. Deploying a site on Windows XP
      5m 9s
    4. Installing Information Internet Services (IIS) on Windows Vista, Windows 7, and Windows 8
      1m 56s
    5. Configuring ASP.NET 3.5 on Windows Vista
      2m 15s
    6. Deploying an application on Windows Vista
      3m 29s
    7. Scripting a database for deployment
      3m 36s
    8. Exporting database scripts in SQL Server Management Studio 2012 (NEW)
      3m 20s
  15. 2m 0s
    1. Where to go from here
      2m 0s

Start learning today

Get unlimited access to all courses for just $25/month.

Become a member
Sometimes @lynda teaches me how to use a program and sometimes Lynda.com changes my life forever. @JosefShutter
@lynda lynda.com is an absolute life saver when it comes to learning todays software. Definitely recommend it! #higherlearning @Michael_Caraway
@lynda The best thing online! Your database of courses is great! To the mark and very helpful. Thanks! @ru22more
Got to create something yesterday I never thought I could do. #thanks @lynda @Ngventurella
I really do love @lynda as a learning platform. Never stop learning and developing, it’s probably our greatest gift as a species! @soundslikedavid
@lynda just subscribed to lynda.com all I can say its brilliant join now trust me @ButchSamurai
@lynda is an awesome resource. The membership is priceless if you take advantage of it. @diabetic_techie
One of the best decision I made this year. Buy a 1yr subscription to @lynda @cybercaptive
guys lynda.com (@lynda) is the best. So far I’ve learned Java, principles of OO programming, and now learning about MS project @lucasmitchell
Signed back up to @lynda dot com. I’ve missed it!! Proper geeking out right now! #timetolearn #geek @JayGodbold
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.


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 "Already a member? Log in

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 ASP.NET Essential Training.

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

Your file was successfully uploaded.

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.