Visual basic commenting update#
Visual basic commenting code#

Visual basic commenting code#

You can add or remove comment symbols for a block of code by selecting one or more lines of code and choosing the Comment ( ) and Uncomment ( ) buttons on the Edit toolbar. Variables, controls, and procedures should be named clearly enough that commenting is needed only for complex implementation details.Р”В¬omments cannot follow a line-continuation sequence on the same line. Lists each affected external variable, control, or file, and the effect it has (only if it is not obvious)Р”В®xplains the values returned by the procedureР”В®very important variable declaration should be preceded by a comment describing the use of the variable being declared. Lists each external variable, control, open file, or other element accessed by the procedure Comment typeР”Вescribes what the procedure does (not how it does it) Write what works best, both for you and for anyone else who reads your code. These are suggestions Visual Basic does not enforce rules for adding comments. The following table provides general guidelines for what types of comments can precede a section of code. Some comments might need three or more lines. ' This comment is too long to fit on a single line, so we break If your comment requires more than one line, use the comment symbol on each line, as the following example illustrates. Text1.Text = 'Hi!' ' This is an inline comment. ' This is a comment beginning at the left edge of the screen. Both are illustrated in the following code.

Visual basic commenting update#

When you include implementation details in the description, remember to update them when you update the function.Р”В¬omments can follow a statement on the same line, or occupy an entire line. How to comment A comment is preceded by an apostrophe. Since the Visual Basic compiler ignores comments, you can include them anywhere in a program without affecting your code. You should separate the implementation details (how the procedure does it) from comments that describe the functional characteristics. VISUAL BASIC LANGUAGE VB.NET Comments 12668 Comments can be used to document what the program does and what specific blocks or lines of code do. This is for your own benefit and the benefit of anyone else who examines the code. It is good programming practice to begin all procedures with a brief comment describing the functional characteristics of the procedure (what it does). Comments are brief explanatory notes added to code for the benefit of those reading it. This symbol tells the Visual Basic compiler to ignore the text following it, or the comment. As you read the code examples, you often encounter the comment symbol ( ').