Options on Debugging
Options on Debugging
Debugging and Separate Files
Introduction
As you know already, a program can use many files, some files come from the .NET Framework, some are created by Microsoft Visual Studio when you start a project, and you create the others as you judge them necessary for your project. As a result, when debugging, you can consider files that are linked at one time or another. The process of debugging is primarily the same. You just have to keep in mind that you are dealing with many classes and probably different files. This has some consequences on the results you see.
Practical Learning: Debugging With a Class
public class Customer
{
public string FullName;
public string PhoneNumber;
public Customer(string name = "John Doe", string phone = "000-000-0000")
{
FullName = name;
PhoneNumber = phone;
}
}
public class Employee
{
public long EmployeeNumber;
public string FirstName;
public string LastName;
public string Title;
public Employee(long emplNbr = 0,
string fName = "Unknown",
string lName = " Not Specified",
string position = "Loan Specialist")
{
EmployeeNumber = emplNbr;
FirstName = fName;
LastName = lName;
Title = position;
}
public string GetEmployeeName()
{
return LastName + ", " + FirstName;
}
}
public class LoanInformation
{
public double Principal;
public double InterestRate;
public double Period;
public double InterestAmount;
public double FutureValue;
}using System;
public class LoanEvaluation
{
private Employee clerk;
private Customer client;
private LoanInformation loan;
public LoanEvaluation()
{
clerk = new Employee();
client = new Customer();
loan = new LoanInformation();
}
private void IdentifyEmployee()
{
Console.WriteLine("Enter the following pieces of information " +
"about the employee who prepared this loan.");
Console.Write("Employee #: ");
clerk.EmployeeNumber = long.Parse(Console.ReadLine());
Console.Write("First Name: ");
clerk.FirstName = Console.ReadLine();
Console.Write("Last Name: ");
clerk.LastName = Console.ReadLine();
Console.Write("Title: ");
clerk.Title = Console.ReadLine();
}
private void IdentifyCustomer()
{
Console.WriteLine("Enter the following pieces of information " +
"about the customer for whom this loan was prepared.");
Console.Write("Customer Name: ");
client.FullName = Console.ReadLine();
Console.Write("Phone Number: ");
client.PhoneNumber = Console.ReadLine();
}
private void GetLoanValues()
{
Console.WriteLine("Enter the following pieces of information " +
"about the values used for the loan.");
Console.Write("Enter the principal: ");
loan.Principal = double.Parse(Console.ReadLine());
Console.Write("Enter the interest rate: ");
loan.InterestRate = double.Parse(Console.ReadLine()) / 100;
Console.Write("Enter the number of months: ");
loan.Period = double.Parse(Console.ReadLine()) / 12;
}
public void Show()
{
loan.InterestAmount = loan.Principal * loan.InterestRate * loan.Period;
loan.FutureValue = loan.Principal + loan.InterestAmount;
Console.WriteLine("======================================");
Console.WriteLine("Loan Summary");
Console.WriteLine("=------------------------------------=");
Console.WriteLine("Prepared by: {0} - {1}\n {2}",
clerk.EmployeeNumber,
clerk.GetEmployeeName(), clerk.Title);
Console.WriteLine("=------------------------------------=");
Console.WriteLine("Prepared for: {0}\n {1}",
client.FullName, client.PhoneNumber);
Console.WriteLine("=------------------------------------=");
Console.WriteLine("Principal: {0:F}", loan.Principal);
Console.WriteLine("Interest Rate: {0:P}", loan.InterestRate);
Console.WriteLine("Period For: {0} months", loan.Period * 12);
Console.WriteLine("Interest Amount: {0:F}", loan.InterestAmount);
Console.WriteLine("Future Value: {0:F}", loan.FutureValue);
Console.WriteLine("======================================");
}
}Using Separate Files
Instead of just one class or one file, we have learned, and will continue learning, that, to organize your project, you can create the classes of your project in different files. When you debug a project that uses different classes or files that contain classes, the debugger is aware of the objects and where they are created. As we will learn later, there are various windows that assist you with identifying the objects of your project. As a result, the tools such as the Locals window display their contents accordingly.
As you know already, the starting point of a C# application is the Main() function (in C#, that would be a class that contains a method named Main). If you start debugging an application that uses many code files (files that contain classes), the debugger must first identify the file that contains the Main() function. If you are debugging a normal console application but the debugger cannot find a file that contains the Main() function, you would receive an error, indicating that your project does not contain an entry point.
Practical Learning: Debugging Classes
Error 1 Program '. . .\WattsALoan2\WattsALoan2\obj\x86\Debug\WattsALoan2.exe' does not contain a static 'Main' method suitable for an entry point WattsALoan2
using System;
public class LoanEvaluation
{
. . . No Change
public static int Main()
{
LoanEvaluation evaluation = new LoanEvaluation();
Console.Title = "Watts A Loan?";
Console.WriteLine("This application allows you to evaluate a loan");
evaluation.IdentifyEmployee();
evaluation.IdentifyCustomer();
Console.Clear();
evaluation.GetLoanValues();
Console.Clear();
evaluation.Show();
System.Console.ReadKey();
return 0;
}
}
three times..| Employee #: | 41920 |
| First Name: | Donna |
| Last Name: | Jones |
| Title: | Account Manager |
| Customer Name: | Hermine Simms |
| Customer Phone: | 410-573-2031 |
| Principal: | 3250 |
| Number of Months: | 36 |
The Error List
You are probably familiar with the Error List window because if you have ever made any mistake in your code, it would come up. The Error List is a window that displays the list of the current errors in your code. Most of the times, the Error List is present, usually below the Code Editor. At any time, to display it, on the main menu, you can click VIEW -> Error List or press Ctrl + W. While you are working on your code, the Error List may be minimized. To permanently keep it showing, you can click its AutoHide button.
The Error List uses two sequences of how it decides to show the errors. While writing your code, if the live parser, which continuously runs while you are writing your code, finds a problem, it makes a list of all types of violations, even if there is only one mistake, or there appears to be only one mistake. It shows the list in a table:
Another sequence, or a different list, gets created if you build your code. This time, it is the debugger's list that would show:
It is important to know that one mistake could be violating more than one rule of the C# language.
As seen in our introduction to syntax errors, if you are using Microsoft Visual C# (whether Microsoft Visual Studio Express 2013 for Windows Desktop or Microsoft Visual Studio), while you are writing your code, if the parser senses a problem, it underlines the section in the Code Editor and the Error List shows its analysis of that problem. The Error list uses a table made of 5 columns that are Description, File, Line, Column, and Project. You don't have to use all those columns. To specify what columns to show or hide, right-click anywhere in the body of the Error List and position the mouse on Show Columns:
To show a column, put a check mark on its menu item. To hide a column, remove its check mark. The list of errors displays in an incremental order specified by the parser. Otherwise, you can arrange the order based on a column of your choice. To do this, right-click any entry in the Error List, position the mouse on Sort By, and click the column of your choice.
As mentioned already, the Error List uses various columns to show its findings:
To jump to an error from the Error List, locate its entry in the Error List window and double-click it. The caret would be positioned to that Line number, that character Column or word, and in that File of that Project. If you correct the problem and if the parser concludes that your correction is fine, the error would be removed automatically from the Error List. You can continue this to correct all problems and, eventually, the Error List would be emptied.
Objects Assisting With Debugging
The Immediate Window
The Immediate window is a special text editor that can be used to test values, operations (calculations), variables, and methods. To display the Immediate window, on the main menu, you can click Debug -> Windows -> Immediate. The Immediate window appears as a blank object:
To use it, you must write something. What you write depends on what you want to test. An expression you write should start with a question mark but in some cases you can omit that symbol. Because the Immediate window is a text editor, you can copy code from somewhere else and paste it in it. If the immediate window starts being crowded, to empty it, you can right-click inside the window and click Clear All.
After typing or pasting the expression, press Enter. The next line would show the result. For example, imagine you want to test an arithmetic operation such as the addition of 248.49 and 57.26, you would type ?248.49 + 57.26 (the empty spaces are optional and you can include as many as you want) and press Enter. Here is an example:
If you want to test a variable or a method, you must first write code that has the variable. That is, before testing a variable, create a method or use the Main() function and declare the variable in it. If you try testing a variable that is not declared, you would receive an error. One way you can test a variable consists of assigning a certain value, probably a wrong value, to it and observe the result. You can start the assignment expression with a question mark but that mark is not necessary. Here is an example:
The Immediate window allows you to test the value that a variable is currently holding. To get this information, in the Immediate window, type the name of the variable preceded by a question mark (you can also juste type the name of the variable) and press Enter:
If the variable had previously received a value, when you enquire of it in the Immediate window, its current value would show:
Another test you can perform on a variable consists of adding a value to it to increase it, or subtracting a value from it.
To test a method in the Immediate window, the method should return a value. To get the value that a mehod is currently returning, type its name in the Immediate window and press Enter. You can also precede the name of the method with a question mark. Here is an example:
In the same way, you can create more elaborate methods and test them in the Immediate window.
Practical Learning:
Using the Immediate Window
double grossPay = 0D;
double timeWorked = 0D;
double hourlySalary = 0.00D;
// double federalIncomeTax = 0.00D;
// const double FICATaxRate = 0.0765; // 7.65%
// double FICATaxAmount = 0.00D;
double totalDeductions = 0.0D;
double netPay = 0.00D;
Console.Title = "Payroll Evaluation";
/*
Console.WriteLine("To test a payroll, enter the following pieces of information");
Console.Write("Time Wored: ");
timeWorked = double.Parse(Console.ReadLine());
Console.Write("Hourly Salary: ");
hourlySalary = double.Parse(Console.ReadLine());
Console.Write("Enter the amount of the deductions: ");
totalDeductions = double.Parse(Console.ReadLine());
*/
grossPay = hourlySalary * timeWorked;
netPay = grossPay - totalDeductions;
Console.Clear();
Console.WriteLine("=======================");
Console.WriteLine("Payroll Evaluation");
Console.WriteLine("-----------------------");
Console.WriteLine("Time Worked: {0, 7}", timeWorked.ToString("F"));
Console.WriteLine("Hourly Salary: {0, 7}", hourlySalary.ToString("F"));
Console.WriteLine("Gross Pay: {0, 7}", grossPay.ToString("F"));
Console.WriteLine("Deductions: {0, 7}", totalDeductions.ToString("F"));
Console.WriteLine("Net Pay: {0, 7}", netPay.ToString("F"));
Console.WriteLine("=======================\n");
The Autos Window
As debugging progresses, sometimes you may want to know the values that the variables are holding on the current and the preceding lines. To give you this information, Microsoft Visual Studio provides the Autos window (Microsoft Visual Studio Express 2013 for Windows Desktop doesn't have the Autos window). Normally, when you start debugging, the Autos window comes up. If it is hidden while you are debugging, on the main menu, click Debug -> Windows -> Autos.
The Watch Window
Imagine you have a variable that is accessed in various parts of your code. One way you can test the behavior of that variable is to test its value as it circumstancially changes time after time. The Watch window is an object that allows you to monitor the values that a variable (or many variables) holds (or have) in various parts of a method.
To get the Watch window, start debugging your application (DEBUG -> Start Debugging or DEBUG -> Step Into). The Watch window would appear, usually next to the Locals window. The Watch window appears as a table with three columns. Their roles will be obvious to you once the window contains something.
To actually use the services of a Watch window, you must create one or more entries, which are referred to as watches. Before creating a watch, you must start stepping into your code, which is done by clicking DEBUG -> Step Into or by pressing F11.
To create a watch, remember that you must first Step Into your code, then click Debug -> QuickWatch... In the Expression combo box, type the name of the variable you want to watch. Here is an example:
You can also type an expression such as a value added to a variable. Here is an example:
If you want to submit the entry, click the Add Watch button. As an alternatice, in both Microsoft Visual C# versions, in the Watch window, double-click under the Name header, type either the name of the variable only or an expression that has the variable and an operation, then press Enter.
After creating the desired entries in the Watch window, continue debugging. You will see the values being automatically updated in the Value column of the Watch window.
If you don't need a certain entry in the Watch window, you can remove it, or you can delete all entries in the window. To remove an entry, right-click it and click Delete Watch. To remove all entries, right-click anywhere in the Watch window and click Clear All.
Practical Learning:
Using the Watch Window
The IntelliTrace Window
While debugging, you are usually curious to know what line, section, or file is currently being examined:
If you are using Microsoft Visual Studio 2013 Ultimate, to get all of this information in one group, you can use a window named IntelliTrace. To get the IntelliTrace window (in Microsoft Visual Studio 2013 Ultimate only)
|
|
|||
| Previous | Copyright © 2010-2024, FunctionX | Friday 15 October 2021 | Next |
|
|
|||